Skip to content

Commit 191174a

Browse files
authored
Doc: versioning and deprecation policy (#277)
Add versioning and deprecation policy
1 parent 4360836 commit 191174a

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

doc/development.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Development
2+
===========
3+
4+
Versioning
5+
----------
6+
7+
We use `Semantic Versioning <http://semver.org/>`_ with the modifications
8+
described under :ref:`deprecation_policy`.
9+
10+
.. _deprecation_policy:
11+
12+
Deprecation policy
13+
------------------
14+
15+
petab aims to provide a stable API for users. However, not all features can be
16+
maintained indefinitely. We will deprecate features in minor releases and
17+
where possible, issue a warning when they are used. We will keep deprecated
18+
features for at least six months after the release that includes the
19+
respective deprecation warning and then remove them earliest in the next minor
20+
or major release. If a deprecated feature is the source of a major bug, we may
21+
remove it earlier.
22+
23+
Python compatibility
24+
--------------------
25+
26+
We follow `numpy's Python support policy <https://numpy.org/neps/nep-0029-deprecation_policy.html>`_.

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
Changelog <CHANGELOG.md>
1515
how_to_cite
1616
license
17+
development
1718

1819
.. toctree::
1920
:maxdepth: 2

0 commit comments

Comments
 (0)