Repository navigation
chore(license): MIT license, SPDX headers, third-party notices and contributor docs - #40
Merged
Merged
Conversation
…ntributor docs Add the MIT LICENSE and COPYRIGHT (Orama Search Inc.), an SPDX-License-Identifier: MIT line in every source file, THIRD_PARTY_LICENSES, CONTRIBUTING.md (DCO sign-off, no CLA) and CODE_OF_CONDUCT.md (Contributor Covenant 2.1), for the open-source release's license gate. Regenerate: - headers: python3 tools/spdx-headers.py (idempotent; --check lists files without one) - third-party notices: `uv export --frozen --no-dev` of uv.lock, installed into a scratch venv, then `pip-licenses --with-license-file --with-notice-file` (runtime dependencies only)
25 tasks
The exact legal name, from Steve on 2026-11-15, replaces "Orama Search Inc." in LICENSE, COPYRIGHT and the notices.
tools/sbom.py writes sbom.spdx.json (SPDX 2.3) and sbom.cdx.json (CycloneDX) from the files git tracks at one commit: the packages syft finds in the lock files, plus the C and C++ components of the third-party license list, the git submodules and the Dockerfile base images. The creation time and namespace come from the source commit, so the files are reproducible; python3 tools/sbom.py --check says when they are stale.
… of the DCO CLA.md assigns the copyright in each contribution to OramaSearch, Inc., with a fallback exclusive licence where an assignment is not effective, a licence back to the contributor, a patent licence, and an entity version for employers. A contributor signs it once, electronically, through a bot on their first pull request. CONTRIBUTING.md, README.md and COPYRIGHT describe it in place of the DCO sign-off.
Contributor
Author
|
Merged into |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What: MIT
LICENSEandCOPYRIGHT(OramaSearch, Inc.), anSPDX-License-Identifier: MITline in every source file,THIRD_PARTY_LICENSES,CONTRIBUTING.md, a copyright-assignmentCLA.mdandCODE_OF_CONDUCT.md.Why: Gate G4 (licenses) of the open-source release, https://github.com/oramasearch/orama-bridge/issues/276, part of https://github.com/oramasearch/orama-bridge/issues/272 (this repo's epic #34). D1: MIT for every repo Orama wrote; D6 (changed by Steve, 2026-11-15): contributors assign copyright to OramaSearch, Inc. under a signed CLA.
How:
tools/spdx-headers.pyadds the header (idempotent,--checkfor a gate);THIRD_PARTY_LICENSESis generated:uv export --frozen --no-devof uv.lock, installed into a scratch venv, thenpip-licenses --with-license-file --with-notice-file(runtime dependencies only). The copyright holder is named once, inCOPYRIGHTandLICENSE.Changes
LICENSE(MIT),COPYRIGHT: Copyright (c) 2026 OramaSearch, Inc. (Steve, 2026-11-15).tools/spdx-headers.pyand the headers it added. It skips submodules, vendored and test-data folders, data formats and SQL, and never edits a file that carries someone else's notice.THIRD_PARTY_LICENSES: every component with its license text.CONTRIBUTING.md: build and test, pull requests todev, the CLA (CLA.md, signed once), security reports to security@orama.com.CODE_OF_CONDUCT.md: Contributor Covenant 2.1, reports to conduct@orama.com.README.md: a short License section at the end.SECURITY.mdis not here: it arrives in docs: add a security policy (SECURITY.md) #36.Third-party findings
Nothing incompatible with MIT distribution among the 17 runtime Python packages: all are MIT, BSD, Apache-2.0, PSF-2.0, MIT-CMU or MPL-2.0.
MPL-2.0 (file-level copyleft) applies to certifi, used unmodified as a library: compatible; a change to their files would have to be published under MPL-2.0.
The container image is python:3.12-slim (Debian + CPython): its Debian packages keep their own licenses (some GPL/LGPL), recorded in the image; see THIRD_PARTY_LICENSES.
Conflicts
Many open pull requests touch the same source files. The header hunks are one line at the top of each file: on a conflict, take the other side's version of the file and re-run
python3 tools/spdx-headers.py.Needs a human
Tests not run: per Steve, 2026-11-14, tests run at review and release time. Only the header script and the license tools ran; nothing was built.
sbom.spdx.json(SPDX 2.3) andsbom.cdx.json(CycloneDX), 26 components, made reproducibly from the tracked tree bytools/sbom.py(syft, plus the C and C++ components of the license list, the submodules and the Dockerfile base images); regenerate withpython3 tools/sbom.py, check with--check. Validated with pyspdxtools; no local paths, private repos or internal hosts.