Skip to content

docs: a package documents the third-party code it contains - #267

Merged
CaffeinatedCoder merged 1 commit into
release/2.4.0from
docs/third-party-licenses
Oct 31, 2026
Merged

CaffeinatedCoder merged 1 commit into
release/2.4.0from
docs/third-party-licenses

Conversation

@CaffeinatedCoder

Copy link
Copy Markdown
Owner

Closes #180

Problem

Nothing in the repository says how a package documents third-party licenses. The question came from a generated THIRD-PARTY-NOTICES.TXT in another project: 102 entries, test packages included, links and no license texts. That shape suits an application that ships its dependencies, but not obviously a library that only references them.

Change

  • Decision 125 (design/adr/0125-...): a package carries a THIRD-PARTY-NOTICES.txt only when it contains third-party code (a bundled or merged assembly, copied source, a binary release). The file is built from the shipping closure alone and holds the license texts.
  • CONTRIBUTING: a new section, "Licenses and third-party code".
  • AGENTS.md: the rule, under "Rules that are easy to break".
  • The decisions' index: its row.

The record's status is open: the decision is the maintainer's to accept. Flip it to accepted, in the record and its index row, before merging if it stands.

Tests

Documentation only. CodoMetis.TypeKit.Conventions.Tests: 2,055 passed on release/2.4.0 at 251f016, including the record's numbering, title, date, status and index checks and the documentation links. The measurements behind the decision (package contents, dependencies, no copied code) are in the record's Evidence.

🤖 Generated with Claude Code

Decision 125: a package carries a THIRD-PARTY-NOTICES.txt only when it contains
third-party code (a bundled assembly, copied source, a binary release), built
from the shipping closure with the license texts. A package that bundles
nothing, which is every package today, documents its own license, copyright
and dependency list, and its dependencies' licenses are held to an allow-list
by a conventions test (#181), not listed. No SBOM is shipped.

CONTRIBUTING gains "Licenses and third-party code", AGENTS.md the rule.

Refs #180

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@CaffeinatedCoder CaffeinatedCoder added this to the 2.4.0 milestone Oct 31, 2026
@CaffeinatedCoder CaffeinatedCoder added documentation Improvements or additions to documentation area/release Versioning, changelogs, packaging and release wiring labels Oct 31, 2026
@CaffeinatedCoder
CaffeinatedCoder merged commit 3737187 into release/2.4.0 Oct 31, 2026
12 checks passed
@CaffeinatedCoder
CaffeinatedCoder deleted the docs/third-party-licenses branch October 31, 2026 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/release Versioning, changelogs, packaging and release wiring documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant