Skip to content

Add a CHANGELOG #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robo9k opened this issue Feb 15, 2015 · 0 comments
Open

Add a CHANGELOG #6

robo9k opened this issue Feb 15, 2015 · 0 comments

Comments

@robo9k
Copy link

robo9k commented Feb 15, 2015

Especially with automated releases upon git tags as in #5 , the releases should have a text snippet explaining the changes from the previous published version.
Those snippets should mention how users can fix their code (if possible) if the version contains breaking changes as per semver.
The snippets should not be generated from git commit messages, as those are often not helpful (e.g. "Update dependencies", "Fix links", "Add initial AppVeyor config" and such).

The same snippets should be contained in a CHANGELOG (or possibly CHANGELOG.md) file.
The bumpversion README looks very similar to what I propose here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant