Changelog?
jescalan opened this issue · 10 comments
It doesn't seem like there's a changelog anywhere, so I can't be sure if things will break or what has changed when I update the version 😕
It doesn't really make sense IMHO to have a changelog for such a small module. You can easily see the changes in the commit log: https://github.com/yeoman/configstore/commits/master
Or even better. Compare the version you use with the latest one:
v0.2.3...v0.3.0
I feel like forcing your users to read the source to attempt to determine what has changed or if there were any breaking changes just doesn't seem like a very good practice no matter how small the module. At very least, you could add release notes when you push a new release?
+1 for changelog
Without one it is hard to know what is breaking like @Jenius said. Even if you do follow semver it is super helpful to have.
@Jenius just curious, how would a changelog look for v0.2.3...v0.3.0 ?
I guess:
- More restrictive default permissions
Sure, that sounds fine to me - maybe even a bit more detail on what exactly that means, or a link to the pull request where it was discussed. If I see the version move up in a way that could potentially be breaking, all I want is a quick summary of what changed and whether there were indeed any breaking changes to the API, without having to sort through the code/commits manually. I assume this is most peoples' use cases as well, but could be wrong.
Just as an example @sindresorhus this is how i do them for marionette...
https://github.com/marionettejs/backbone.marionette/blob/master/changelog.md#v180-view-commit-logs
Sure it takes more work but it also requires you to audit the release and also gives you a handy link to tweet and share.
+100 @sindresorhus
💖
💺 🐟 🐋 🐒