About changelog generator
A changelog tells users what changed in each release. The format follows Keep a Changelog, with sections for added, changed, fixed and removed.
Good entries
- Write for users, not for developers: describe the effect, not the code.
- List the newest version first, with its date.
- Mention breaking changes and deprecations clearly.
A worked example
A release entry looks like '## [1.5.0] - 2026-03-12' followed by Added: 'Export to CSV', Changed: 'Faster search' and Fixed: 'Crash when the list is empty'. The newest version goes on top and an Unreleased section collects changes before the next release.
Writing for readers
- Describe what the user can now do, not which files changed.
- Group items by type so people find fixes and features quickly.
- Call out breaking changes at the top.
Linking
Add comparison links at the bottom of the file so that each version heading links to the GitHub compare view of that release.
