Skip to content

Commit b90f0ef

Browse files
committed
add language about keeping changes smooth
1 parent a0ae810 commit b90f0ef

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/developers/contributing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,8 @@ may release breaking changes in ``minor`` releases, or even ``patch`` releases u
305305
But we should strive to avoid doing so. A better model for our versioning scheme is `Intended Effort Versioning <https://jacobtomlinson.dev/effver/>`_, or "EffVer".
306306
The guiding principle off EffVer is to categorize releases based on the *expected effort required to upgrade to that release*.
307307

308+
Zarr developers should make changes as smooth as possible for users. This means making backwards-compatible changes wherever possible.
309+
When a backwards-incompatible change is necessary, users should be notified well in advance, e.g. via informative deprecation warnings.
308310

309311
Data format compatibility
310312
^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)