🚀Changelog
Also known as Change Log, CHANGELOG.md, Release Notes
A file that lists what changed in each release. The newest is at the top.
Think of it like
Think of it like a diary for your project. Each entry says what changed on that day.
Example
Lucy wants to update a package from 3.1 to 3.4. She reads its changelog, sees one removed option she uses, and updates her code first.
Why it matters
Without one, users must read every commit to learn what an update does. Most will not, and they get surprised.
Definition
Example code
markdown
## 2.4.0 - 2026-11-02
### Added
- Dark mode
### Fixed
- Login button on small screensCommon mistake
Key takeaways
- 1One heading per version. Number and date.
- 2Grouped changes. Added, changed, fixed.
- 3Written for people. Not a commit dump.