Document the release notes format in the contributor guide - #417
Merged
Conversation
Release notes were written from scratch each time, so the section order, the contributor credits and the ko-fi block drifted between releases. Codify the structure the recent releases converged on: mandatory sections, when the optional ones apply, how change lines credit contributors, and the Thanks block reproduced verbatim. Point the release procedure and AGENTS.md at it instead of restating a subset. Co-authored-by: Claude <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.
Summary
Release notes were written from scratch each time, so the section order, the contributor credits and the ko-fi block
drifted between releases. This codifies the structure recent releases converged on, in
CONTRIBUTING.md§ Releases.Type of change
Notes for reviewer
The format is descriptive, not invented — it is what
v1.87.0…v1.92.0already do, with the inconsistenciesresolved one way:
### Thanksbefore the changelog line (as inv1.90.0/v1.92.0), not after it (v1.88.0,v1.89.0).by @SpaiRsuffix; external contributors always keep the credit.<details>block (v1.87.0precedent) with an explicit note that they do not reach thepublished artifacts.
The rules live in
CONTRIBUTING.mdrather than a separate template file: § Releases is already the canonical home forthe release procedure, and step 5 of "Cutting a release" was a one-line restatement of a subset — it now links to the
new section instead.
AGENTS.mdgets a pointer in the same style as the neighbouring bullets.The
v1.92.7.1draft has already been rewritten against this format.