aind-data-schema icon indicating copy to clipboard operation
aind-data-schema copied to clipboard

Clarify library versioning scheme

Open bruno-f-cruz opened this issue 4 months ago • 0 comments

Is your feature request related to a problem? Please describe.

The current repository states that the library is following semver:

Be aware that this package is still under heavy preliminary development. Expect breaking changes regularly, although we will communicate these through semantic versioning.

However, the most recent release broke the 1.x version. Specifically, I believe that the following two PRs are not backward compatible: #1035 #1074

Describe the solution you'd like I do understand that strictly following semver will likely be very hard given the goal of this library. However, I still think that from both a dev and user point of view, releases must be more transparent regarding breaking changes. Therefore I ask that, similarly to other libraries like pydantic, to explicitly tag the breaking changes in the release notes (or even keep a changelog).

Describe alternatives you've considered Strictly follow semver and bump the major release on breaking changes.

Additional context Add any other context or screenshots about the feature request here.

bruno-f-cruz avatar Oct 13 '24 18:10 bruno-f-cruz