Update contributing docs to mention semver#266
Merged
Conversation
Collaborator
Author
|
|
sandrina-p
approved these changes
Jul 17, 2026
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.
Our releases should follow semver, but it was not clearly stated in the docs.
Disables release of
majorversions to prevent accidental bumps. Matches v0 package scripts.Note
Low Risk
Documentation and release-script validation only; no runtime library behavior changes.
Overview
Documents Semantic Versioning in the stable-release section of
CONTRIBUTING.md, including when to use patch vs minor bumps and that major bumps are intentionally disabled to keep v1 backward compatible.Adds a bump-type →
pnpm run releasecommand table and tightens the release steps (including a stable-version example instead of beta-style version strings).Aligns
scripts/release.jswith the docs by removingmajorfrom allowed official bump types, with a comment explaining it avoids accidental major releases.Reviewed by Cursor Bugbot for commit 6dcaae3. Bugbot is set up for automated code reviews on this repo. Configure here.