from Hacker News

Ask HN: What are some examples of good changelogs?

by tucif on 7/30/20, 10:55 PM with 5 comments

• by forgotmypw17 on 7/31/20, 1:00 AM

  I can't say they are good, because my commit messages get technical, and because I'm not very good at git, but here is my process.

  My project is in early stages and I am primary developer. I only have several instances I am supporting.

  I upgrade by doing a git checkout and ./rebuild.pl.

  Whenever the value of current git pointer changes, it automatically generates a changelog of all the commit messages between the previous pointer and current.

  As long as I write clear commit messages, my changelogs automatically contain useful information.

  I can also add comments in reply to the changelogs.

  All of it is automatically accessible via #meta hashtag

• by aprdm on 7/31/20, 7:19 AM

  I have been using this: https://keepachangelog.com/en/1.0.0/

  I particularly like the consul changelog https://github.com/hashicorp/consul/blob/master/CHANGELOG.md which follows it.