docs: tighten release writing standard - #12
Merged
Conversation
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
Tightens the OpenNotes release-writing guide and PR template after another pass against real OSS release notes.
Why
The previous guide was better than a build receipt, but still too broad and a little inflated. Patch releases should read like patch releases: short, specific, and easy to scan.
Changes
docs/release-writing.mdaround concrete OSS patterns from Rust, React, Electron, GitHub CLI, Node.js, and Keep a Changelog.What changedsection toChangesand made the instruction more direct.Testing
git diff --checkRelease note