release-notes
Installation
SKILL.md
Release Notes
Release notes answer what changed for one reader and what that reader needs to do. Every entry must be true for the version it sits under.
Identify the reader
Each surface serves one reader at one level of detail:
| Reader | Typical surfaces | What they need |
|---|---|---|
| End users and customers | In-app "what's new", changelog page, store notes, customer emails | Outcomes they will notice, in product vocabulary |
| Developers who consume the project | Package changesets, GitHub releases, API changelogs | Changed APIs and defaults, deprecations, migration steps |
| Maintainers | CHANGELOG.md technical history, commits, PRs, ADRs |
Mechanisms, pins, and the reasons behind them |