Skip to content

Commit 58a8150

Browse files
committed
add backwards compatibility policy
1 parent 0ac3eaa commit 58a8150

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

doc/en/backwards-compatibility.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _backwards-compatibility:
2+
3+
Backwards Compatibility Policy
4+
==============================
5+
6+
Keeping backwards compatibility has a very high priority in the pytest project. Although we have deprecated functionality over the years, most of it is still supported. All deprecations in pytest were done because simpler or more efficient ways of accomplishing the same tasks have emerged, making the old way of doing things unnecessary.
7+
8+
With the pytest 3.0 release we introduced a clear communication scheme for when we will actually remove the old busted joint and politely ask you to use the new hotness instead, while giving you enough time to adjust your tests or raise concerns if there are valid reasons to keep deprecated functionality around.
9+
10+
To communicate changes we are already issuing deprecation warnings, but they are not displayed by default. In pytest 3.0 we changed the default setting so that pytest deprecation warnings are displayed if not explicitly silenced (with ``--disable-pytest-warnings``).
11+
12+
We will only remove deprecated functionality in major releases (e.g. if we deprecate something in 3.0 we will remove it in 4.0), and keep it around for at least two minor releases (e.g. if we deprecate something in 3.9 and 4.0 is the next release, we will not remove it in 4.0 but in 5.0).

doc/en/contents.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Full pytest documentation
2020
cache
2121
plugins
2222

23+
backwards-compatibility
2324
contributing
2425
talks
2526

0 commit comments

Comments
 (0)