Add changelog/README.rst and streamline our PR template text #3192
Conversation
This streamlines the PR template text and adds a more in-depth explanation about how the changelog entries work because this topic is a common source of confusion: - How to name the files. - Which formatting to use (people in general assume it is Markdown). - Recommend adding `.rst` extension to changelog files to help with the above (`towncrier` doesn't care). This was heavily inspired by the excellent python-trio/trio docs.
|
Glad to help 👍 |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| * Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files." | ||
| - [ ] Target: for `bugfix`, `vendor`, `doc` or `trivial` fixes, target `master`; for removals or features target `features`; | ||
| - [ ] Make sure to include reasonable tests for your change if necessary | ||
| - [ ] Create a new changelog file into the `changelog` folder, with a name like `<ISSUE NUMBER>.<TYPE>.rst`. See [changelog/README.rst](/changelog/README.rst) for details. |
changelog/README.rst
Outdated
| * ``feature``: new user facing features, like new command-line options and new behavior. | ||
| * ``bugfix``: fixes a reported bug. | ||
| * ``doc``: documentation improvement, like rewording an entire session or adding missing docs. | ||
| * ``removal``: feature deprecation or removal; |
There was a problem hiding this comment.
It looks like you switched from . to ; here?
changelog/README.rst
Outdated
| * ``bugfix``: fixes a reported bug. | ||
| * ``doc``: documentation improvement, like rewording an entire session or adding missing docs. | ||
| * ``removal``: feature deprecation or removal; | ||
| * ``vendor``: vendoring news; |
There was a problem hiding this comment.
Might want to be a bit verbose here and give some context on what vendoring means - something like "Changes in packages vendored in pytest." or so? On the other hand, didn't we get rid of vendoring anyways?
There was a problem hiding this comment.
Good point, updated.
We are not vendoring anything more at the moment, but we might do it again in the future. I guess we can always remove this later if we officially abolish the practice.
|
Applied all your suggestions @The-Compiler, thanks! |
|
LGTM now, thanks! |
|
Huh, tried to merge this from my phone but I get a 404 - feel free to merge it! |
|
Back on my laptop, let's merge! 🎉 |
This streamlines the PR template text and adds a more in-depth explanation
about how the changelog entries work because this topic is a common source of
confusion:
.rstextension to changelog files to help with theabove (
towncrierdoesn't care).This was heavily inspired by the excellent
python-trio/triodocs, I hope @njsmith doesn't mind. 😁