Skip to content

Commit c4f059b

Browse files
[PR documentation] Add advice to keep the pull requests small (#8330)
Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
1 parent 8f24c69 commit c4f059b

File tree

2 files changed

+32
-17
lines changed

2 files changed

+32
-17
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,18 @@ Thank you for submitting a PR to pylint!
33
44
To ease the process of reviewing your PR, do make sure to complete the following boxes.
55
6-
- [ ] Write a good description on what the PR does.
7-
- [ ] Create a news fragment with `towncrier create <IssueNumber>.<type>` which will be
8-
included in the changelog. `<type>` can be one of: breaking, user_action, feature,
9-
new_check, removed_check, extension, false_positive, false_negative, bugfix, other, internal.
10-
If necessary you can write details or offer examples on how the new change is supposed to work.
6+
- [ ] Document your change, if it is a non-trivial one.
7+
- A maintainer might label the issue ``skip-news`` if the change does not need to be in the changelog.
8+
- Otherwise, create a news fragment with ``towncrier create <IssueNumber>.<type>`` which will be
9+
included in the changelog. ``<type>`` can be one of the types defined in `./towncrier.toml`.
10+
If necessary you can write details or offer examples on how the new change is supposed to work.
11+
- Generating the doc is done with ``tox -e docs``
12+
- [ ] Relate your change to an issue in the tracker if such an issue exists (Refs #1234, Closes #1234)
13+
- [ ] Write comprehensive commit messages and/or a good description of what the PR does.
14+
- [ ] Keep the change small, separate the consensual changes from the opinionated one.
15+
Don't hesitate to open multiple PRs if the change requires it. If your review is so
16+
big it requires to actually plan and allocate time to review, it's more likely
17+
that it's going to go stale.
1118
- [ ] If you used multiple emails or multiple names when contributing, add your mails
1219
and preferred name in ``script/.contributors_aliases.json``
1320
-->

doc/development_guide/contributor_guide/contribute.rst

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,32 @@ your patch gets accepted:
6767

6868
.. keep this in sync with the description of PULL_REQUEST_TEMPLATE.md!
6969
70-
- Create a news fragment with `towncrier create <IssueNumber>.<type>` which will be
71-
included in the changelog. `<type>` can be one of: breaking, user_action, feature,
72-
new_check, removed_check, extension, false_positive, false_negative, bugfix, other, internal.
73-
If necessary you can write details or offer examples on how the new change is supposed to work.
70+
- Document your change, if it is a non-trivial one:
7471

75-
- Document your change, if it is a non-trivial one.
72+
* A maintainer might label the issue ``skip-news`` if the change does not need to be in the changelog.
73+
* Otherwise, create a news fragment with ``towncrier create <IssueNumber>.<type>`` which will be
74+
included in the changelog. ``<type>`` can be one of the types defined in `./towncrier.toml`.
75+
If necessary you can write details or offer examples on how the new change is supposed to work.
76+
* Generating the doc is done with ``tox -e docs``
7677

77-
- If you used multiple emails or multiple names when contributing, add your mails
78-
and preferred name in the ``script/.contributors_aliases.json`` file.
78+
- Send a pull request from GitHub (see `About pull requests`_ for more insight about this topic).
7979

80-
- Write a comprehensive commit message
81-
82-
- Relate your change to an issue in the tracker if such an issue exists (see
80+
- Write comprehensive commit messages and/or a good description of what the PR does.
81+
Relate your change to an issue in the tracker if such an issue exists (see
8382
`Closing issues via commit messages`_ of the GitHub documentation for more
8483
information on this)
8584

86-
- Send a pull request from GitHub (see `About pull requests`_ for more insight
87-
about this topic)
85+
- Keep the change small, separate the consensual changes from the opinionated one.
86+
87+
* Don't hesitate to open multiple PRs if the change requires it. If your review is so
88+
big it requires to actually plan and allocate time to review, it's more likely
89+
that it's going to go stale.
90+
* Maintainers might have multiple 5 to 10 minutes review windows per day, Say while waiting
91+
for their teapot to boil, or for their partner to recover from their hilarious nerdy joke,
92+
but only one full hour review time per week, if at all.
93+
94+
- If you used multiple emails or multiple names when contributing, add your mails
95+
and preferred name in the ``script/.contributors_aliases.json`` file.
8896

8997
.. _`Closing issues via commit messages`: https://github.blog/2013-01-22-closing-issues-via-commit-messages/
9098
.. _`About pull requests`: https://support.github.com/features/pull-requests

0 commit comments

Comments
 (0)