from Hacker News

Ask HN: What Makes a Good Changelog?

by Xavdidtheshadow on 4/11/22, 10:01 PM with 4 comments

When you have to update your project's dependencies, you (presumably) look at the changelogs for each package to see if you can safely update. This experience varies wildly based on how well changes are tracked and documented (if at all). I'm looking to suss out what separates a great changelog from a mediocre one.

  - What bits of a changelog are most helpful / important? 
  - What's not helpful, but usually included?
  - How should the document balance skimmability / comprehensiveness / readability?
  - What projects have the most helpful changelogs?
Thank you!

  • by macshome on 4/11/22, 11:23 PM

    Overall I like the format and advice from https://keepachangelog.com/

    We’ve adopted it at work and it’s nice to have a consistent format that is relatively noise free.

  • by trinovantes on 4/11/22, 10:44 PM

    Honestly, the only things I care about are breaking changes and migration steps

    Everything else is just noise