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

rename CHANGES to CHANGELOG & indicate breaking changes #399

Open
benjaminapetersen opened this issue Apr 29, 2016 · 4 comments
Open

rename CHANGES to CHANGELOG & indicate breaking changes #399

benjaminapetersen opened this issue Apr 29, 2016 · 4 comments

Comments

@benjaminapetersen
Copy link

  • CHANGELOG is just a suggestion, seems to be the best suggestion (I've seen) for a conventional filename (per something like this: http://keepachangelog.com/)
  • The current changelog mentions no breaking changes, even for major version changes. True? If so, nothing to do here!

Thx!

@ljharb
Copy link
Member

ljharb commented Apr 29, 2016

@benjaminapetersen
Copy link
Author

Curious if it would be possible/worth the effort to note each item in the changelog as bug fix, feature, breaking (or some variation).

@ljharb
Copy link
Member

ljharb commented May 4, 2016

Totally possible, it's just not a convention I've previously followed in this repo (i do in other repos). I'll start doing it, regardless.

@benjaminapetersen
Copy link
Author

Awesome!

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

No branches or pull requests

2 participants