Skip to content

Commit 36ef545

Browse files
committed
Improve instructions on how to write CHANGELOG entries
This makes easier for contributors to get the CHANGELOG entry right the first time.
1 parent f36ea24 commit 36ef545

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,13 @@ Here is a quick checklist that should be present in PRs.
1111
Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:
1212
1313
- [ ] Create a new changelog file in the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](https://github.com/pytest-dev/pytest/blob/master/changelog/README.rst) for details.
14+
15+
Write sentences in the **past or present tense**, examples:
16+
17+
* *Improved verbose diff output with sequences.*
18+
* *Terminal summary statistics now use multiple colors.*
19+
20+
Also make sure to end the sentence with a `.`.
21+
1422
- [ ] Add yourself to `AUTHORS` in alphabetical order.
1523
-->

changelog/README.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
This directory contains "newsfragments" which are short files that contain a small **ReST**-formatted
22
text that will be added to the next ``CHANGELOG``.
33

4-
The ``CHANGELOG`` will be read by users, so this description should be aimed to pytest users
4+
The ``CHANGELOG`` will be read by **users**, so this description should be aimed to pytest users
55
instead of describing internal changes which are only relevant to the developers.
66

7-
Make sure to use full sentences with correct case and punctuation, for example::
7+
Make sure to use full sentences in the **past or present tense** and use punctuation, examples::
88

9-
Fix issue with non-ascii messages from the ``warnings`` module.
9+
Improved verbose diff output with sequences.
10+
11+
Terminal summary statistics now use multiple colors.
1012

1113
Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
1214
``<ISSUE>`` is an issue number, and ``<TYPE>`` is one of:

0 commit comments

Comments
 (0)