Skip to content

docs: add a deprecation policy to the contributing guide#4051

Open
maxrjones wants to merge 5 commits into
zarr-developers:mainfrom
maxrjones:docs/deprecation-policy
Open

docs: add a deprecation policy to the contributing guide#4051
maxrjones wants to merge 5 commits into
zarr-developers:mainfrom
maxrjones:docs/deprecation-policy

Conversation

@maxrjones

Copy link
Copy Markdown
Member

Closes #2924.

This PR adds a deprecation policy to the contributing guide, so there's a shared framework all contributors and maintainers can apply rather than re-deriving one for each PR. Making it a public doc also gives users visibility into how we handle breaking changes.

The policy is consistent with our EffVer versioning and covers scope, decision framework, mechanics, minimum period, and exceptions to the policy.

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/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

Closes zarr-developers#2924.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Comment thread docs/contributing.md Outdated
@maxrjones maxrjones self-assigned this Jun 15, 2026
@maxrjones maxrjones requested a review from a team June 26, 2026 18:09
@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.50%. Comparing base (e29ddd2) to head (153117c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4051   +/-   ##
=======================================
  Coverage   93.50%   93.50%           
=======================================
  Files          90       90           
  Lines       11981    11981           
=======================================
  Hits        11203    11203           
  Misses        778      778           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

define our deprecation policy

2 participants