Summary
Add a CHANGELOG.md to track notable changes across releases, following the Keep a Changelog format.
Motivation
The project uses hatch-vcs for versioning from git tags but has no human-readable changelog. A structured changelog makes it easier for users and contributors to understand what changed between releases without digging through commit history.
Proposal
- Add a
CHANGELOG.md at the project root following the Keep a Changelog convention
- Organize entries under: Added, Changed, Deprecated, Removed, Fixed, Security
- Backfill entries for existing releases (if any tagged releases exist)
- Update CONTRIBUTING.md to mention changelog updates as part of the PR process
Summary
Add a CHANGELOG.md to track notable changes across releases, following the Keep a Changelog format.
Motivation
The project uses
hatch-vcsfor versioning from git tags but has no human-readable changelog. A structured changelog makes it easier for users and contributors to understand what changed between releases without digging through commit history.Proposal
CHANGELOG.mdat the project root following the Keep a Changelog convention