From f261219d1f8b55e70ed575552b169df3b29cd435 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Wed, 26 Jun 2024 14:27:06 +0200 Subject: [PATCH] move to separate document --- CHANGELOG.md | 10 +--------- documentation/index.rst | 1 + documentation/versioning_policy.rst | 28 ++++++++++++++++++++++++++++ 3 files changed, 30 insertions(+), 9 deletions(-) create mode 100644 documentation/versioning_policy.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index 62660fff71..fcdc7a222a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,6 @@ # Changelog -## 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. +See also our [versioning policy](https://amici.readthedocs.io/en/latest/versioning_policy.html). ## v0.X Series diff --git a/documentation/index.rst b/documentation/index.rst index 73343e76c1..63fc3261ab 100644 --- 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 new file mode 100644 index 0000000000..bed419f02a --- /dev/null +++ b/documentation/versioning_policy.rst @@ -0,0 +1,28 @@ +.. _versioning_policy: + +Versioning policy +================= + +Versioning +---------- + +We use `Semantic Versioning `_ 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 `_.