release-notes
Installation
SKILL.md
Skill: release notes
Owns the body of a GitHub release. The git-commit skill owns the mechanics around it: version bump commit, tag, signing, gh release create, and the post-publish check.
The one rule
A CHANGELOG is a complete record for people who already use the project. Release notes are for someone deciding whether to. Pasting one into the other produces a wall nobody reads.
Keep the changelog complete. Link to it from the first line.
Formatting
- Never hard-wrap. One paragraph is one line, however long. GitHub reflows it; your 80-column breaks render as a ragged left column that looks broken on a wide screen. This is the single most common mistake.
- No em-dashes. Use a comma, a colon, a full stop, or parentheses. If a dash is genuinely right, use a spaced hyphen:
word - word. - Bold lead-in on every bullet.
- **Batched inference** (default on): crops are stacked .... The reader scans the bold and stops where it matters. - Credit contributors as a bare
@handle. GitHub builds the release's contributors section (avatars under the notes) from@handlementions in the body; a linked name or plain name does not trigger it. Put every contributor and the reviewer in a## Creditssection as@handle, not[Name](https://github.com/handle). - Never
@<digit>.@4and@5render as a mention of some GitHub user; writev4or wrap the package spec in backticks. Do not@anyone who did not work on the release.