Breaking change should have mahor version bump #600
Replies: 3 comments 2 replies
-
Hi @ChristianSch, indeed. We are aware of semver and would love to adhere to it at the moment we get an stable, public API, reaching 1.0. For that reason we have broken the public APIs a few times and not bumped the major version of the project. In that sense, we are very cautious about when to do a breaking change, and we try to notify it in the changelog. Some of the reasons that we have considered to break the API has been related to see changes rapidly into the project with no other option than to break the API. On the other hand we understand that it could have caused some trouble in downstream consumers, and because of that we do try to be extremely conservative about it. I'd like to apologize if it broke you for some reasons. About the CHANGELOG.md file, would like to understand the need to add it apart from the GH format. Is that an automated process that consumes it? We are open to add it if there is a valuable need on it. |
Beta Was this translation helpful? Give feedback.
-
Thank you for the well-articulated response, I appreciate that! Being on 0.x.x and thus not doing major version bumps is a very good reason that I actually overlooked to be honest. I totally understand that you want to wait until the API feels rather stable. Although some projects never bump to v1, I hope this does 🤞 CHANGELOG.md on the other hand is just convenience. If you don't update very version you have to click quite a lot to get a feeling for the breaking changes, as for the CHANGELOG.md file you can just scroll down. But I have no strong feeling either way, I was just kind of confused that it wasn't there. |
Beta Was this translation helpful? Give feedback.
-
I'm closing this now, as it's already been discussed. Thank you for your time |
Beta Was this translation helpful? Give feedback.
-
Hi,
I noticed that 0.15.0 includes a breaking change without bumping the major version. Please see here:
https://semver.org/
It would be very helpful to properly make use of that. Was there a reason not to do this?
While we're at it, would it be possible to have a CHANGELOG.md file, in addition to the github-bound format?
Beta Was this translation helpful? Give feedback.
All reactions