summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-12-21 23:11:24 +0100
committerDaniël van Noord <13665637+DanielNoord@users.noreply.github.com>2022-12-27 00:15:03 +0100
commitd272005665640e519fa5ff2631afe24c6f58c113 (patch)
treec02cdc8377c7dcb067145c62256e15d69ac479e6 /.github
parenta96e05bf73b6fbba8edf78aa9adde3e1faa16b66 (diff)
downloadastroid-git-d272005665640e519fa5ff2631afe24c6f58c113.tar.gz
[doc] Make the pull request template more like pylint
Diffstat (limited to '.github')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md27
1 files changed, 12 insertions, 15 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 9263735d..52ae7487 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,17 +1,13 @@
<!--
-
Thank you for submitting a PR to astroid!
-To ease our work reviewing your PR, do make sure to mark the complete the following boxes.
-
--->
-
-## Steps
+To ease the process of reviewing your PR, do make sure to complete the following boxes.
-- [ ] For new features or bug fixes, add a ChangeLog entry describing what your PR does.
- [ ] Write a good description on what the PR does.
-
-## Description
+- [ ] For new features or bug fixes, add a ChangeLog entry describing what your PR does.
+- [ ] If you used multiple emails or multiple names when contributing, add your mails
+ and preferred name in ``script/.contributors_aliases.json``
+-->
## Type of Changes
@@ -24,11 +20,12 @@ To ease our work reviewing your PR, do make sure to mark the complete the follow
| ✓ | :hammer: Refactoring |
| ✓ | :scroll: Docs |
-## Related Issue
+## Description
-<!--
-If this PR fixes a particular issue, use the following to automatically close that issue
-once this PR gets merged:
+<!-- If this PR references an issue without fixing it: -->
-Closes #XXX
--->
+Refs #XXXX
+
+<!-- If this PR fixes an issue, use the following to automatically close when we merge: -->
+
+Closes #XXXX