Changelog
The changelog should summarize shipped changes in language that helps operators and integrators decide what matters.
Good changelog entries
Section titled “Good changelog entries”Good entries explain the effect, not just the commit. For example, “Refresh token reuse is now rejected and audited” is more useful than “Update token model.”
Group entries by audience when possible:
- Admin changes.
- User portal changes.
- Developer/API changes.
- Security changes.
- Fixes.
- Migration notes.
Source of truth
Section titled “Source of truth”This page can be generated from GitHub releases or release notes, but it should stay readable as documentation. Link deeper compatibility pages for changes that require careful rollout.