kirodotdev release-notes
When to use
Asked to draft the changelog section for a version bump.
Steps
- Read the commit range and partition it -- account for every commit.
- Group by what the reader gets, most interesting first. Never by commit type.
- Lead with breaking changes when the release has any.
Gotchas
- A list of commit subjects is not a changelog section.
- Never restate a count of commits.