diff options
author | Kevin J. Foley <kfoley15@gmail.com> | 2019-06-24 20:55:51 -0400 |
---|---|---|
committer | Kevin J. Foley <kfoley15@gmail.com> | 2019-06-24 20:55:51 -0400 |
commit | 23aa3bb0ae02bf138a5650f44d67b697cf405172 (patch) | |
tree | 7263218e42f853ea0d4345ff941d366ace55930d /CONTRIBUTING.rst | |
parent | 3f5b078462774d29ed61ad5ec1a9e09acf6a7374 (diff) | |
download | pytest-23aa3bb0ae02bf138a5650f44d67b697cf405172.tar.gz |
Clarify changelog entries should be rst files
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 57628a34b..ec053c081 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -173,7 +173,7 @@ Short version The test environments above are usually enough to cover most cases locally. -#. Write a ``changelog`` entry: ``changelog/2574.bugfix``, use issue id number +#. 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. #. Unless your change is a trivial or a documentation fix (e.g., a typo or reword of a small section) please @@ -264,7 +264,7 @@ Here is a simple overview, with pytest-specific bits: $ git commit -a -m "<commit message>" $ git push -u -#. Create a new changelog entry in ``changelog``. The file should be named ``<issueid>.<type>``, +#. 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``. |