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

Breaking changes in v3? #319

Open
yelworc opened this issue Jan 26, 2024 · 1 comment
Open

Breaking changes in v3? #319

yelworc opened this issue Jan 26, 2024 · 1 comment

Comments

@yelworc
Copy link

yelworc commented Jan 26, 2024

Hi, you recently published a new major version (v3.0.0), but I cannot find any corresponding documentation/changelog. More recent releases don't seem to be tagged in git either, so it's not straightforward to get a diff view of the changes.

Any release docs (e.g. a CHANGELOG.md or in GitHub releases), at least for breaking changes, would be very helpful for users of this lib 🙂

@fergiemcdowall
Copy link
Owner

A major semver release (when the first number in the version increments, eg 2.x.x -> 3.x.x) should always be treated as a "breaking change".

That said, we should be better at documenting new releases. Thanks for the feedback, I will make a better changelog next time.

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