From db9565a7abe219f35c6dda665557b5917d2cf2c6 Mon Sep 17 00:00:00 2001 From: Loris Leiva Date: Fri, 28 Aug 2026 15:41:48 +0100 Subject: [PATCH] Soften the spec-major coupling in CONTRIBUTING This PR aligns CONTRIBUTING.md with the clarified invariant: the monorepo's rule is one shared major per era; coinciding with the spec major is today's convenience, not a commitment. Codama-only majors with ecosystem impact run the full candidacy per [RELEASING.md](https://github.com/codama-idl/spec/blob/HEAD/RELEASING.md). --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bfa80cab7..73d9c23d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Both pins are exact rather than ranges, so generated output only changes through ## Changesets -Any user-facing change needs a changeset: run `npx changeset add --empty` and edit the created file. One changeset file per concern; entries start with a verb. Never edit `CHANGELOG.md` files — they are generated by the release workflow. Note that the core packages (`codama`, `@codama/errors`, `@codama/node-types`, `@codama/nodes`, `@codama/validators` and the `@codama/visitors*` packages) version in lockstep as a fixed group, while the remaining packages version independently — below a shared ceiling: **all public packages carry the same major version** (the era, matching the branch name and the spec major it supports), so no package ever bumps its major on its own. Breaking changes to individual packages wait for the next major cut. +Any user-facing change needs a changeset: run `npx changeset add --empty` and edit the created file. One changeset file per concern; entries start with a verb. Never edit `CHANGELOG.md` files — they are generated by the release workflow. Note that the core packages (`codama`, `@codama/errors`, `@codama/node-types`, `@codama/nodes`, `@codama/validators` and the `@codama/visitors*` packages) version in lockstep as a fixed group, while the remaining packages version independently — below a shared ceiling: **all public packages carry the same major version** (the era, matching the branch name), so no package ever bumps its major on its own; breaking changes to individual packages wait for the next major cut. The era currently coincides with the spec major it supports — a convenience, not a rule: an ecosystem-impacting codama-only major (no spec change) is legitimate and runs the full candidacy per RELEASING.md. ## Releasing a new major of the Codama standard