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

Use “Keep A CHANGELOG” format for CHANGELOG.md #31

Closed
wants to merge 2 commits into from
Closed

Use “Keep A CHANGELOG” format for CHANGELOG.md #31

wants to merge 2 commits into from

Conversation

Zearin
Copy link

@Zearin Zearin commented Mar 1, 2015

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.

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.
@jkrems
Copy link
Contributor

jkrems commented Mar 1, 2015

Hi! Thanks for the proposal! Interesting project, never heard about it before. I really like that it actually links the versions to the /compare/ page.

Unfortunately we generate this file semi-automatically using npub. Changing the format without making the change in npub first won't be maintainable. I created EndangeredMassa/npub#29 for discussion.

[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
Copy link
Contributor

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.

Copy link
Author

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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed!

@Zearin
Copy link
Author

Zearin commented Mar 1, 2015

Unfortunately we generate this file semi-automatically using npub. Changing the format without making the change in npub first won't be maintainable. I created EndangeredMassa/npub#29 for discussion.

Cool! I am unfamiliar with npub. I’ll check it out in the meantime.

@ghost
Copy link

ghost commented Mar 2, 2015

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.

@jkrems
Copy link
Contributor

jkrems commented Mar 2, 2015

@khoomeister Everything that advertises the existence of compare URLs is a net win in my book ;)

@jkrems
Copy link
Contributor

jkrems commented Dec 28, 2015

Moved to groupon/nlm#10

@jkrems jkrems closed this Dec 28, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants