Documentation
README
Release Notes (Agent Sessions)
CHANGELOG vs. release notes (read first)
These are two different documents with opposite jobs. Do not apply this skill to the first one.
CHANGELOG (docs/CHANGELOG.md) |
Release notes (README "What's New", GitHub release, Sparkle, website) | |
|---|---|---|
| Audience | Internal / maintainers (but the curated top feeds users) | Users |
| Job | Working development history + a curated release section | The net change a user sees on update |
| Granularity | Granular bullets while in [Unreleased]; curated headings at release |
Curated, collapsed, headline-first |
| This skill | Governs its curated section (Highlights/Features/Bug Fixes); leaves the granular working bullets alone | Governs all of it |
This is the opening of the README. Read the full README on GitHub.