Add deprecation policy (#2465)

Add deprecation policy As suggested in #2458.
AMICI-dev · Jun 26, 2024 · f54abe6 · f54abe6
1 parent 474b473
commit f54abe6
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Changelog
 
+See also our [versioning policy](https://amici.readthedocs.io/en/latest/versioning_policy.html).
+
 ## v0.X Series
 
 ### v0.25.2 (2024-06-16)

diff --git a/documentation/index.rst b/documentation/index.rst
@@ -27,6 +27,7 @@ Welcome to AMICI's documentation!
    references
    background
    changelog
+   versioning_policy
    glossary
    contributing
 

diff --git a/documentation/versioning_policy.rst b/documentation/versioning_policy.rst
@@ -0,0 +1,28 @@
+.. _versioning_policy:
+
+Versioning policy
+=================
+
+Versioning
+----------
+
+We use `Semantic Versioning <http://semver.org/>`_ with the modifications
+described under :ref:`deprecation_policy`.
+
+.. _deprecation_policy:
+
+Deprecation policy
+------------------
+
+AMICI aims to provide a stable API for users. However, not all features can be
+maintained indefinitely. We will deprecate features in minor releases and
+where possible, issue a warning when they are used. We will keep deprecated
+features for at least six months after the release that includes the
+respective deprecation warning and then remove them earliest in the next minor
+or major release. If a deprecated feature is the source of a major bug, we may
+remove it earlier.
+
+Python compatibility
+--------------------
+
+We follow `numpy's Python support policy <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_.