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

Changelog for v2.0 does not mention breaking changes #171

Closed
nickcampbell18 opened this issue Sep 14, 2017 · 2 comments
Closed

Changelog for v2.0 does not mention breaking changes #171

nickcampbell18 opened this issue Sep 14, 2017 · 2 comments

Comments

@nickcampbell18
Copy link

Hello,

We use Dependabot to help us keep our dependencies up to date. This means that we usually spend a bit of time looking at Github releases or changelogs to see if a change is safe.

Looking at the changelog for v2.0, it doesn't mention any breaking changes, so we merged the upgrade, but of course it broke things unexpectedly 😄

Might be worth adding this section from the readme to the changelog to help other users?

Thanks!

@broofa broofa closed this as completed in 3ec557d Sep 14, 2017
@broofa
Copy link
Owner

broofa commented Sep 14, 2017

Sorry about that. I've only just started to get serious about maintaining a changelog and haven't been diligent about creating issues for the significant changes. (FWIW, I'm using github-release-notes to auto-generate changelog.md, so adding the readme notes was slightly more involved.)

@nickcampbell18
Copy link
Author

Not a problem - thank you for the quick fix!

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