Live data from Hacker News

Keep a Changelog

keepachangelog.com

51–53 of 53 posts

Re: Keep a Changelog

#52
Commit messages often aren't nontechnical enough to make for an accessible changelog.

I would like to encourage developers to maintain changelog for their projects, but to host the changelogs outside of the project's Git repository. Maybe put it on the "Wiki" or "Releases" pages on GitHub.

When the changelog is an actual file in the Git repository, it becomes another source for merge and rebase conflicts.

Re: Keep a Changelog

#53

I've been hand-writing a CHANGELOG.md file, in each of my repos, for a long time. Before that, I used to keep it as a section of my README.md file. I got used to the second file, after using CocoaPods. I don't really use CocoaPods anymore, but they would render the CHANGELOG.md file in a separate tab, which was nice. I don't think anyone else does that. I think a hand-written changelog is better than a semantically-g…

FYI. Here’s a very long CHANGELOG (over ten years):

https://github.com/bmlt-enabled/bmlt-root-server/blob/master...

It was in the README for most of that time. It has just been broken out into a separate file, by the new team.

Post reply on HN