Skip to main content

A CHANGLOG isn't just a list of Git commits

Yesterday, I wrote about keeping a CHANGELOG for software projects, and about the https://keepachangelog.com project.

I like this slogan on their website:

Don’t let your friends dump git logs into changelogs.

A CHANGELOG shouldn't be a list of Git commits in a file.

It should be in a human-readable format that's easy for people to read and understand, whether they are technical or not.

This probably isn't the case for the output from git log, which may also contain commits like Refactor and wip that don't mean anything to someone who focused on the higher-level deliverables.

Git logs are great for Developers, but CHANGELOGs are for everyone.

Was this interesting?

Subscribe to my daily newsletter for software professionals on software development and delivery, Drupal, DevOps, community, and open-source.

About me

Picture of Oliver

I'm a certified Drupal Triple Expert and former Drupal Association staff member with 18 years of experience, a Drupal core contributor, public speaker, live streamer, and host of the Beyond Blocks podcast.