-
Notifications
You must be signed in to change notification settings - Fork 27
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
Use “Keep A CHANGELOG” format for CHANGELOG.md #31
Conversation
It’s not a formal standard, but I think it should be: http://keepachangelog.com It’s basically a collection of sensible things for keeping a changelog meaningful and optimizing human readability.
Hi! Thanks for the proposal! Interesting project, never heard about it before. I really like that it actually links the versions to the Unfortunately we generate this file semi-automatically using |
[1.0.1]: https://github.com/groupon/cson-parser/compare/v1.0.1...v1.0.0 | ||
[1.0.0]: https://github.com/groupon/cson-parser/compare/v1.0.0...v0.2.0 | ||
[0.2.0]: https://github.com/groupon/cson-parser/compare/v0.2.0...v0.1.1 | ||
[0.1.1]: https://github.com/groupon/cson-parser/compare/v0.1.1...v0.1.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All of the above links have the tag order backwards, and thus don't work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aw, crap! I meant to check those before I submitted this, but I forgot. Thanks for catching it!
Will fix soon.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed!
Cool! I am unfamiliar with |
If we added PR links for each line item, the version compare link is semi-redundant, plus harder to understand. Nevertheless it's quite easy to automate so it could be useful for people who don't link to the individual diffs. |
@khoomeister Everything that advertises the existence of compare URLs is a net win in my book ;) |
Moved to groupon/nlm#10 |
It’s not a formal standard, but I think it should be:
http://keepachangelog.com
It’s basically a collection of sensible things for keeping a changelog meaningful and optimizing human readability.