Skip to content

chore(license): MIT license, SPDX headers, third-party notices and contributor docs - #40

Merged
homer6 merged 5 commits into
devfrom
chore/g4-licenses
Nov 16, 2026
Merged

homer6 merged 5 commits into
devfrom
chore/g4-licenses

Conversation

@homer6

@homer6 homer6 commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

What: MIT LICENSE and COPYRIGHT (OramaSearch, Inc.), an SPDX-License-Identifier: MIT line in every source file, THIRD_PARTY_LICENSES, CONTRIBUTING.md, a copyright-assignment CLA.md and CODE_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.py adds the header (idempotent, --check for a gate); THIRD_PARTY_LICENSES is generated: 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). The copyright holder is named once, in COPYRIGHT and LICENSE.

Changes

  • LICENSE (MIT), COPYRIGHT: Copyright (c) 2026 OramaSearch, Inc. (Steve, 2026-11-15).
  • tools/spdx-headers.py and 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 to dev, 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.md is 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: sbom.spdx.json (SPDX 2.3) and sbom.cdx.json (CycloneDX), 26 components, made reproducibly from the tracked tree by tools/sbom.py (syft, plus the C and C++ components of the license list, the submodules and the Dockerfile base images); regenerate with python3 tools/sbom.py, check with --check. Validated with pyspdxtools; no local paths, private repos or internal hosts.

…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)
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.
@homer6
homer6 merged commit d99ee9c into dev Nov 16, 2026
@homer6
homer6 deleted the chore/g4-licenses branch November 16, 2026 06:12
@homer6

homer6 commented Nov 16, 2026

Copy link
Copy Markdown
Contributor Author

Merged into dev as a merge commit (d99ee9cb) on Steve's review (2026-11-15). Low risk, on Steve's 2026-11-15 instruction to merge the low-risk PRs. Not built or tested in review (tests run at the release cut).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant