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

Please include Changelog #3338

Closed
shyamal890 opened this issue Sep 20, 2016 · 9 comments
Closed

Please include Changelog #3338

shyamal890 opened this issue Sep 20, 2016 · 9 comments

Comments

@shyamal890
Copy link

There is no way to track breaking changes as new versions are released.

If there is one in place, please consider including a link in ReadMe section.

@etimberg
Copy link
Member

@shyamal890 what breaking changes are you running into?

The release notes details all of the changes that are made in each version

@panzarino
Copy link
Contributor

You can check the previous history of releases on the releases page.

@etimberg
Copy link
Member

Closing since @zachpanz88's answer is correct

@shyamal890
Copy link
Author

@etimberg That is not what I am asking for, there is no way from the releases write-up to know which are the breaking changes we should be aware of before updating.

@simonbrunel
Copy link
Member

@shyamal890 The releases section is exactly what you need to track when considering updating because it contains all the release notes. If there is a breaking change, it will be listed (and highlighted) for the concerned release. If there is nothing about a breaking change, then that's a regression.

I'm +1 to add a link to the releases from the README.md if that can help people to figure out where are the release notes. If that's not enough, then I'm not sure what you are suggesting?

@shyamal890
Copy link
Author

I would suggest something like this: https://github.com/angular-ui/bootstrap/blob/master/CHANGELOG.md#133-2016-05-23

And yes, link in the README.md would be a great help

@simonbrunel
Copy link
Member

How that's different from https://github.com/chartjs/Chart.js/releases? Both contains exactly the same information.

@shyamal890
Copy link
Author

shyamal890 commented Oct 24, 2016

@simonbrunel There is no BREAKING CHANGES section in https://github.com/chartjs/Chart.js/releases

@simonbrunel
Copy link
Member

simonbrunel commented Oct 24, 2016

That's a good news, right? That means Chart.js didn't introduce breaking changes for a while :) If a release has breaking changes, there will be a BREAKING CHANGES section or similar. For the README.md link, PR are welcome ;)

Edit: last breaking changes was in release 2.0.0-beta2 (Breaking API changes)

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

4 participants