summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorRan Benita <ran@unusedvar.com>2020-06-24 15:42:07 +0300
committerRan Benita <ran@unusedvar.com>2020-06-24 16:11:27 +0300
commit474973afa401ea8bf177d89025022d5ea3801c4d (patch)
tree30fec37271bef519f79160a3bf9d7339340781a0 /CONTRIBUTING.rst
parent37929030c912f899385d3a1176df5ac88e578ddf (diff)
downloadpytest-474973afa401ea8bf177d89025022d5ea3801c4d.tar.gz
CONTRIBUTING: sync changelog types
The got out of date with the actual ones we use.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 5e309a317..9ff854ffa 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -173,8 +173,10 @@ Short version
The test environments above are usually enough to cover most cases locally.
#. Write a ``changelog`` entry: ``changelog/2574.bugfix.rst``, use issue id number
- and one of ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or
- ``trivial`` for the issue type.
+ and one of ``feature``, ``improvement``, ``bugfix``, ``doc``, ``deprecation``,
+ ``breaking``, ``vendor`` or ``trivial`` for the issue type.
+
+
#. Unless your change is a trivial or a documentation fix (e.g., a typo or reword of a small section) please
add yourself to the ``AUTHORS`` file, in alphabetical order.
@@ -274,8 +276,9 @@ Here is a simple overview, with pytest-specific bits:
#. Create a new changelog entry in ``changelog``. The file should be named ``<issueid>.<type>.rst``,
where *issueid* is the number of the issue related to the change and *type* is one of
- ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or ``trivial``. You may not create a
- changelog entry if the change doesn't affect the documented behaviour of Pytest.
+ ``feature``, ``improvement``, ``bugfix``, ``doc``, ``deprecation``, ``breaking``, ``vendor``
+ or ``trivial``. You may skip creating the changelog entry if the change doesn't affect the
+ documented behaviour of pytest.
#. Add yourself to ``AUTHORS`` file if not there yet, in alphabetical order.