3 ms·
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
by ChrisMarshallNY 5y ago
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-generated one, because it connects the developers' mindset to the consumer (usually, another developer). It says "These are the aspects of this release that I think are important."
A semantically-written changelog doesn't actually need to be kept. It can be auto-generated on demand. As long as the developer keeps good commit notes, with things like issue numbers, then this could be useful.
- ChrisMarshallNY 5y agoFYI. Here’s a very long CHANGELOG (over ten years): https://github.com/bmlt-enabled/bmlt-root-server/blob/master/CHANGELOG.md 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.