Skip to content

Commit a54e2e1

Browse files
authored
Clarify changelog entries should be rst files (#5485)
Clarify changelog entries should be rst files
2 parents 37fce6c + 23aa3bb commit a54e2e1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Short version
173173

174174
The test environments above are usually enough to cover most cases locally.
175175

176-
#. Write a ``changelog`` entry: ``changelog/2574.bugfix``, use issue id number
176+
#. Write a ``changelog`` entry: ``changelog/2574.bugfix.rst``, use issue id number
177177
and one of ``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or
178178
``trivial`` for the issue type.
179179
#. 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:
264264
$ git commit -a -m "<commit message>"
265265
$ git push -u
266266

267-
#. Create a new changelog entry in ``changelog``. The file should be named ``<issueid>.<type>``,
267+
#. Create a new changelog entry in ``changelog``. The file should be named ``<issueid>.<type>.rst``,
268268
where *issueid* is the number of the issue related to the change and *type* is one of
269269
``bugfix``, ``removal``, ``feature``, ``vendor``, ``doc`` or ``trivial``.
270270

0 commit comments

Comments
 (0)