Skip to content

Soften the spec-major coupling in CONTRIBUTING #1125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lorisleiva merged 1 commit into from
Aug 28, 2026
+1 −1
Merged

Soften the spec-major coupling in CONTRIBUTING #1125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down