Skip to content
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

Conventional Changelog #875

Closed
bufferoverflow opened this issue Jul 3, 2015 · 2 comments
Closed

Conventional Changelog #875

bufferoverflow opened this issue Jul 3, 2015 · 2 comments

Comments

@bufferoverflow
Copy link
Member

What about introducing Conventional Changelog and generate CHANGELOG.md automatically?

here's an example of a generated changelog:
https://github.com/angular/angular.js/blob/master/CHANGELOG.md

and the tool to generate is here https://www.npmjs.com/package/conventional-changelog

@aleks-f
Copy link
Member

aleks-f commented Jul 3, 2015

Yeah, we are not very good about keeping up with changelog entries as we go, so we usually have to go back through commit history and recreate them - painful process.

It looks like this would require following convention when committing and we would need to establish a point when we start following this convention? @obiltschnig ?

@obiltschnig
Copy link
Member

I'm generally in favor of anything that saves us work, but we'll have to improve our commit messages significantly (me included ;-) We could introduce it after 1.7.0. The other issue is the changelog in the generated SDK documentation, which must also be kept up-to-date. Right now it's just a copy-paste of the main CHANGELOG with some minor formatting applied.

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

3 participants