summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJ0J0 Todos <jojo@peek-a-boo.at>2023-10-20 15:06:38 +0200
committerJ0J0 Todos <jojo@peek-a-boo.at>2023-10-29 19:48:10 +0100
commit29c062a81e0c830e9cc98e2f6db9601c5ba6fc99 (patch)
tree03996ed1cc1fc6cf1a16ab2e63decb09352712e8
parent8d7cb5c5958ec06a4c1a21a7165b1f610e4e838f (diff)
Overhaul of pull-request template
- Some notes only visible to the contributor while editing. - Some tiny fixes in the existing texts in braces. - One of the "invisible" notes encourages to remove those help-texts to help uncluttering.
-rw-r--r--.github/pull_request_template.md19
1 files changed, 16 insertions, 3 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 42cd8169b..c3fc7766a 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -6,6 +6,19 @@ Fixes #X. <!-- Insert issue number here if applicable. -->
## To Do
-- [ ] Documentation. (If you've add a new command-line flag, for example, find the appropriate page under `docs/` to describe it.)
-- [ ] Changelog. (Add an entry to `docs/changelog.rst` near the top of the document.)
-- [ ] Tests. (Encouraged but not strictly required.)
+<!--
+- If you believe one of below checkpoints is not required for the change you
+ are submitting, cross it out and check the box nonetheless to let us know.
+ For example: - [x] ~Changelog~
+- Please remove the descriptive sentences in braces from the enumeration below,
+ which helps to unclutter your PR description.
+- Regarding the changelog, often it makes sense to add your entry only once
+ reviewing is finished. That way you might prevent conflicts from other PR's in
+ that file, as well as keep the chance high your description fits with what
+ the latest revision of your feature/fix.
+- Regarding documentation, bugfixes often don't require additions to the docs.
+-->
+
+- [ ] Documentation. (If you've added a new command-line flag, for example, find the appropriate page under `docs/` to describe it.)
+- [ ] Changelog. (Add an entry to `docs/changelog.rst` to the bottom of one of the lists near the top of the document.)
+- [ ] Tests. (Very much encouraged but not strictly required.)