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

update version policy to use effver #2910

Merged
merged 14 commits into from
Mar 22, 2025

Conversation

d-v-b
Copy link
Contributor

@d-v-b d-v-b commented Mar 14, 2025

This changes the versioning policy from something semver-ish to effver.

based on conversations in this issue

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.rst
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

closes #2889

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Mar 14, 2025
Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @d-v-b -- this looks great!

@d-v-b
Copy link
Contributor Author

d-v-b commented Mar 14, 2025

@zarr-developers/python-core-devs it would be good to get yalls eyes on this

Copy link
Contributor

@dstansby dstansby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for tackling this! I left some comments inline. I think a major gap in the policy as it stands is that it doesn't embody @TomAugspurger's excellent points of being considerate to downstream users by:

  • preserving backwards compatibility where possible
  • giving notice of deprecations through FutureWarnings
  • giving users and libraries time to adapt to those deprecations

Matplotlib has some good guidelines on making breaking API changes using deprecations which could be taken as inspiration here.

@d-v-b
Copy link
Contributor Author

d-v-b commented Mar 17, 2025

Thanks for tackling this! I left some comments inline. I think a major gap in the policy as it stands is that it doesn't embody @TomAugspurger's excellent points of being considerate to downstream users by:

  • preserving backwards compatibility where possible
  • giving notice of deprecations through FutureWarnings
  • giving users and libraries time to adapt to those deprecations

Matplotlib has some good guidelines on making breaking API changes using deprecations which could be taken as inspiration here.

@dstansby have a look at the content I added in b90f0ef

@d-v-b
Copy link
Contributor Author

d-v-b commented Mar 18, 2025

does anyone else think a community announcement (e.g. a blog post) would make sense here? If so, I can start working on one

@d-v-b d-v-b requested a review from dstansby March 18, 2025 11:00
@sanketverma1704
Copy link
Member

Thanks for working on this, @d-v-b! Important change.

does anyone else think a community announcement (e.g. a blog post) would make sense here? If so, I can start working on one

We should at least make a social media announcement on BlueSky, LinkedIn, and Mastodon. A blog post would be great! I can take care of the announcements and help with blog writing/review.

A minor suggestion: Can we wrap the text to 80 (or similar) columns?

@github-actions github-actions bot removed the needs release notes Automatically applied to PRs which haven't added release notes label Mar 21, 2025
Copy link
Member

@jhamman jhamman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @d-v-b for leading us through this.

@jhamman jhamman enabled auto-merge (squash) March 22, 2025 16:16
@jhamman jhamman merged commit 8c24819 into zarr-developers:main Mar 22, 2025
30 checks passed
@d-v-b d-v-b deleted the docs/update-version-policy branch March 22, 2025 17:36
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

Successfully merging this pull request may close these issues.

Change versioning policy to allow API breaking in minor versions?
8 participants