docs: link the release runbook from CONTRIBUTING + README - #83
Merged
Conversation
docs/RELEASING.md is the maintainer release runbook, but neither CONTRIBUTING.md nor the README pointed at it as "how to cut a release" (the README only referenced §4 for the demo GIF). Add a short "Releasing" section to CONTRIBUTING.md and a doc-list line to the README so the runbook is discoverable.
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.
Summary
Makes the release runbook discoverable:
docs/RELEASING.mdis the maintainer runbook for cutting a versioned release, but neitherCONTRIBUTING.mdnor the README pointed at it as "how to cut a release" (the README only linked §4 for the demo GIF). This adds a short Releasing section toCONTRIBUTING.mdand a doc-list line to the README, both linkingdocs/RELEASING.md. Docs only — no code, no dependency changes.Linked issue
No issue. Follow-up to #80 (the source-only release workflow), which added the runbook content but left it unlinked from the contributor-facing docs.
Definition of Done
Docs-only change — no Rust, no
Cargo.toml/Cargo.lockdelta, no UI, no secret-handling code, so the build/test/clippy/DESIGN gates are unaffected (CI on this PR confirms).DESIGN.mdN/A)Notes for reviewers
The "Releasing" blurb summarizes the flow (bump versions → promote CHANGELOG →
just release-check→ push tag) and links the full runbook; it intentionally doesn't duplicate the steps.