From c4f059bd08731cd468de712725c9cb0ecfd4e824 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Thu, 23 Feb 2023 23:33:04 +0100 Subject: [PR documentation] Add advice to keep the pull requests small (#8330) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to '.github') diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index dfa06dbbb..1730a08f7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,11 +3,18 @@ Thank you for submitting a PR to pylint! To ease the process of reviewing your PR, do make sure to complete the following boxes. -- [ ] Write a good description on what the PR does. -- [ ] Create a news fragment with `towncrier create .` which will be - included in the changelog. `` can be one of: breaking, user_action, feature, - new_check, removed_check, extension, false_positive, false_negative, bugfix, other, internal. - If necessary you can write details or offer examples on how the new change is supposed to work. +- [ ] Document your change, if it is a non-trivial one. + - A maintainer might label the issue ``skip-news`` if the change does not need to be in the changelog. + - Otherwise, create a news fragment with ``towncrier create .`` which will be + included in the changelog. ```` can be one of the types defined in `./towncrier.toml`. + If necessary you can write details or offer examples on how the new change is supposed to work. + - Generating the doc is done with ``tox -e docs`` +- [ ] Relate your change to an issue in the tracker if such an issue exists (Refs #1234, Closes #1234) +- [ ] Write comprehensive commit messages and/or a good description of what the PR does. +- [ ] Keep the change small, separate the consensual changes from the opinionated one. + Don't hesitate to open multiple PRs if the change requires it. If your review is so + big it requires to actually plan and allocate time to review, it's more likely + that it's going to go stale. - [ ] If you used multiple emails or multiple names when contributing, add your mails and preferred name in ``script/.contributors_aliases.json`` --> -- cgit v1.2.1