Skip to content

Update contributing docs to mention semver#266

Merged
danielcardoso5 merged 2 commits into
mainfrom
chore-document-semver
Jul 17, 2026
Merged

Update contributing docs to mention semver#266
danielcardoso5 merged 2 commits into
mainfrom
chore-document-semver

Conversation

@danielcardoso5

@danielcardoso5 danielcardoso5 commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Our releases should follow semver, but it was not clearly stated in the docs.

Disables release of major versions 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 release command table and tightens the release steps (including a stable-version example instead of beta-style version strings).

Aligns scripts/release.js with the docs by removing major from 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.

@danielcardoso5 danielcardoso5 self-assigned this Jul 15, 2026
@danielcardoso5

danielcardoso5 commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator Author

Updated as I plan to release 2.0.0 due to the breaking changes introduced in #265

@danielcardoso5
danielcardoso5 merged commit 7b5d5dd into main Jul 17, 2026
6 checks passed
@danielcardoso5
danielcardoso5 deleted the chore-document-semver branch July 17, 2026 09:34
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.

2 participants