search

yeoman / configstore

Easily load and persist config without having to think about where and how
BSD 2-Clause "Simplified" License
868 stars 56 forks source link

Changelog? #19

Closed jescalan closed 10 years ago

jescalan commented 10 years ago

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 :confused:

sindresorhus commented 10 years ago

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: https://github.com/yeoman/configstore/compare/v0.2.3...v0.3.0

jescalan commented 10 years ago

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?

samccone commented 10 years ago

+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.

sindresorhus commented 10 years ago

@jenius just curious, how would a changelog look for https://github.com/yeoman/configstore/compare/v0.2.3...v0.3.0 ?

I guess:

jescalan commented 10 years ago

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.

samccone commented 10 years ago

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.

sindresorhus commented 10 years ago

https://github.com/yeoman/configstore/releases/tag/0.3.0

samccone commented 10 years ago

+100 @sindresorhus

jescalan commented 10 years ago

:sparkling_heart:

samccone commented 10 years ago

:seat: :fish: :whale2: :monkey: