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

Support "Keep a Changelog" format? #119

Open
job13er opened this issue Nov 29, 2017 · 1 comment
Open

Support "Keep a Changelog" format? #119

job13er opened this issue Nov 29, 2017 · 1 comment

Comments

@job13er
Copy link
Contributor

job13er commented Nov 29, 2017

Should we update (or allow a configuration change to enable) supporting the Changelog format suggested in Keep a Changelog?

The main differences between their suggestions and how pr-bumper currently handles things:

  1. Using ## instead of # for each release section
  2. Allowing for an arbitrary top-level # and description above version sections (this means we have to be a little smarter than just pre-pending to the file).

The rest of the conventions have to do with the actual contents of the changelog section for the version. Those could possibly be validated by pr-bumper but I'd leave that as a potential, separate feature, as it would require quite a bit more effort and configuration in .pr-bumper.json likely.

@notmessenger
Copy link
Contributor

I will need to dig into the specifics of it to see if there is something that "sticks out" but in general I am all for this. I have not used this specific format before but have done similar in other projects I maintain (https://github.com/softlayer/sl-ember-components/blob/master/CHANGELOG.md#0110) in order to provide a better user experience to consumers and even yourself often enough.

I will likely circle back around and add more content to this thread but wanted to give my initial 👍 on the idea.

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

2 participants