Changelog
ELI5 — The Vibe Check
A Changelog is a file (usually CHANGELOG.md) that records what changed in each version of your software. It's the human-readable history of your project — what got added, what got fixed, what got removed. Without one, users have to read commits or diff code to understand what changed in v2.0.
Real Talk
A changelog is a file containing a chronologically ordered list of notable changes for each version of a project. The Keep a Changelog format groups changes by type (Added, Changed, Deprecated, Removed, Fixed, Security) under dated version headings. Many projects auto-generate changelogs from conventional commit messages.
Show Me The Code
## [2.1.0] - 2025-03-01
### Added
- New dashboard component
- Export to CSV feature
### Fixed
- Login timeout bug on mobile
- Memory leak in WebSocket handler
## [2.0.0] - 2025-02-01
### Breaking Changes
- Removed deprecated /v1 API endpoints
When You'll Hear This
"Update the changelog before cutting the release." / "Users complained they didn't know about the breaking change — it should have been in the changelog."
Related Terms
Breaking Change
A Breaking Change is a modification to your API or library that will BREAK existing code that uses it.
Release
A release is an official versioned snapshot of your software that you hand to the world.
Semantic Versioning (SemVer)
Semantic versioning uses three numbers — MAJOR.MINOR.PATCH — where each number means something. PATCH (1.0.1) = bug fix. MINOR (1.1.
Version Control
Version Control is a system that tracks every change ever made to your files.