Skip to content
BENIBIX Learn

Changelog

Development🚀 Product & ReleasesDocumentation

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

A changelog is a file that lists what changed in each release, newest first. Each version gets its own heading, with its number and date. Under it, changes are grouped, often as Added, Changed, Fixed and Removed. It is written for people, not machines, so it skips tiny details. Users read it to decide whether an update is safe or worth it.

Example code

markdown
## 2.4.0 - 2026-11-02

### Added
- Dark mode

### Fixed
- Login button on small screens
One version, its date, and what was added and fixed.

Common mistake

Pasting the raw commit log as the changelog. It is long, unclear and hides the changes users care about.

Key takeaways

  1. 1
    One heading per version. Number and date.
  2. 2
    Grouped changes. Added, changed, fixed.
  3. 3
    Written for people. Not a commit dump.