| name | release-notes |
| description | Turn verified shipped changes into concise release notes organized around user impact, upgrade implications, fixes, and compatibility concerns. |
Release Notes
Use when a version, deployment, or public release needs an accurate change summary.
Procedure
- Identify the exact release candidate and authoritative list of included changes.
- Group changes by user impact rather than commit order.
- Explain what changed, who it affects, and any action users must take.
- Call out breaking changes, migrations, deprecations, security-sensitive fixes, and known limitations clearly.
- Remove internal implementation detail unless it helps users operate or upgrade safely.
- Verify version numbers, links, commands, feature availability, and dates.
Quality gate
Every claimed change must actually be in the release. A reader should know what matters without reading Git history.