Hacker News new | ask | show | jobs
by kazinator 2459 days ago
I'm sticking to the GNU ChangeLog format, thanks.

https://www.gnu.org/prep/standards/html_node/Change-Logs.htm...

This widely used format gives details about what is being done to each function.

This was designed to be used in a ChangeLog file, so it has to be adopted for repository use. We don't have to record the date and name, since that is in the commit meta-data. WE write a commit title, and then the ChangeLog entry becomes the details placed after the blank line. That entry is mandatory: no title-only commits! There can be one or more discussion paragraphs between the title and the ChangeLog entry. We know that these paragraphs aren't ChangeLog entry material because they don't begin with the asterisk.

Like this: http://www.kylheku.com/cgit/txr/commit/?id=b2739251281d7f6ef...

1 comments

Personally, I feel like this style puts the focus on what rather than the why. I also dislike that it seems to be centered on multiple changes in one commit.