Improve instructions on how to write CHANGELOG entries

This makes easier for contributors to get the CHANGELOG entry
right the first time.
This commit is contained in:
Bruno Oliveira
2019-11-19 14:04:21 -03:00
parent f36ea240fe
commit 36ef545b2d
2 changed files with 13 additions and 3 deletions

View File

@@ -11,5 +11,13 @@ Here is a quick checklist that should be present in PRs.
Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:
- [ ] 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.
Write sentences in the **past or present tense**, examples:
* *Improved verbose diff output with sequences.*
* *Terminal summary statistics now use multiple colors.*
Also make sure to end the sentence with a `.`.
- [ ] Add yourself to `AUTHORS` in alphabetical order.
-->