What Is a Changelog?

A changelog is a file documenting notable changes made to a project across its versions, typically listing additions, fixes, and breaking changes for each re...

Published October 8, 2026

A changelog is a file (usually CHANGELOG.md) that lists notable changes in each release, so users and teammates can see what was added, fixed or broken without reading commits.

The concept

Good changelogs are written for humans, grouped by version with dates, and split into categories: Added, Changed, Deprecated, Removed, Fixed, Security.

The 'Keep a Changelog' convention pairs well with Semantic Versioning, and an 'Unreleased' section collects changes before the next release.

Anatomy

## [1.5.0] - 2026-11-01
### Added
- Dark mode toggle
### Fixed
- Crash when the cart is empty

Practical examples

Entry format

## [Unreleased]
### Added
- Export to CSV

## [1.4.0] - 2026-10-02
### Changed
- Faster search

Generate from conventional commits

npx standard-version
npx conventional-changelog -p angular -i CHANGELOG.md -s

Link versions

[1.5.0]: https://github.com/acme/app/compare/v1.4.0...v1.5.0

Common mistakes

  • Dumping raw git logs.
  • Not marking breaking changes.
  • Forgetting dates and links.

Key takeaways

  • Changelog = human-readable release notes.
  • Group changes by type.
  • Mark breaking changes clearly.

FAQ

Changelog vs release notes?

Changelog is the cumulative history; release notes describe one release for users.

Can I automate it?

Yes, from conventional commit messages.

More General articles