docs(contributing): document release process#89
Merged
Conversation
Adds a Release Process section to CONTRIBUTING.md describing the pnpm run release commands, what commit-and-tag-version does on each non-dry run, the tag-prefix convention (v), the postchangelog hook that writes RELEASE_NOTES.md, and the conventional-commit rules that determine the bump. Closes the last remaining acceptance criterion from #76 — the package.json/tag alignment and the release wiring itself were already fixed in #86. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Closes #76.
Summary
The first and third acceptance criteria from #76 were already resolved in #86 (
chore: versioning hygiene pass):package.jsonis at1.0.0, matching the only published tagv1.0.0.pnpm run releaseis wired tocommit-and-tag-versionwith.versionrc.json(tagPrefixv, conventional-commit types,postchangeloghook that writesRELEASE_NOTES.md).This PR closes the remaining gap — the release process was undocumented for contributors and maintainers.
Changes
CONTRIBUTING.md: new Release Process section between Pull Request Process and Claude Code Agents. Documents:pnpm run releasecommand matrix (:patch/:minor/:major/:dry/:first).commit-and-tag-versiondoes on a non-dry run (bump, CHANGELOG regen,postchangeloghook, commit,v-prefixed tag).git push --follow-tags origin mainto publish.feat:→ minor,fix:→ patch,!/BREAKING CHANGE:→ major), with a backlink to the existing PR Process examples.Test plan
CONTRIBUTING.mdrenders correctly (table syntax + fenced code block).versionrc.json,scripts/extract-release-notes.jspnpm run release*scripts exist inpackage.jsonvmatches.versionrc.jsontagPrefixsetting🤖 Generated with Claude Code