Skip to content

Commit 2b21e14

Browse files
committed
Check that develop is target in PR
This is an update to the PR template. It mostly adds text and some checks related to how good the template is filled in and whether the `develop` branch was selected as base.
1 parent 8caf755 commit 2b21e14

File tree

1 file changed

+39
-7
lines changed

1 file changed

+39
-7
lines changed

.github/pull_request_template.md

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,40 @@
11
<!--
2-
Please don't open an issue when submit PR.
2+
###############################################################################
3+
4+
Thank you for sharing your work and for opening a PR.
5+
6+
(!) IMPORTANT (!):
7+
First make sure that you point your PR to the `develop` branch!
8+
9+
Now please read the comments carefully and try to provide information
10+
on all relevant titles.
11+
12+
###############################################################################
13+
-->
14+
15+
<!--
16+
Please don't open an extra issue when submiting a PR.
17+
18+
But if there is already a related issue, please put it's number here.
19+
20+
E.g. #123 or N/A
21+
-->
322

4-
But if there is already a related issue, please put it's number here. E.g. #123 or N/A -->
523
Related Issue:
624

725
## New Behavior
826

927
<!--
10-
please describe in a few words the behavior your PR implements
28+
Please describe in a few words the intentions of your PR.
1129
-->
1230

1331
...
1432

1533
## Contrast to Current Behavior
1634

1735
<!--
18-
please describe in a few words how the new behavior is different from the current behavior
36+
Please describe in a few words how the new behavior is different
37+
from the current behavior.
1938
-->
2039

2140
...
@@ -24,12 +43,15 @@ please describe in a few words how the new behavior is different from the curren
2443

2544
<!--
2645
Please make your case here:
27-
- Why do you think this project and the community will benefit from your proposed change?
46+
47+
- Why do you think this project and the community will benefit from your
48+
proposed change?
2849
- What are the drawbacks of this change?
2950
- Is it backwards-compatible?
3051
- Anything else that you think is relevant to the discussion of this PR.
3152
32-
(No need to write a huge article here. Just a few sentences that give some additional context about the motivations for the change.)
53+
(No need to write a huge article here. Just a few sentences that give some
54+
additional context about the motivations for the change.)
3355
-->
3456

3557
...
@@ -38,7 +60,17 @@ Please make your case here:
3860

3961
<!--
4062
If the README.md must be updated, please include the changes in the PR.
41-
If the Wiki must be updated, please make a suggestions below.
63+
If the Wiki must be updated, please make a suggestion below.
4264
-->
4365

4466
...
67+
68+
## Double Check
69+
70+
<!--
71+
Please put an x into the brackets (like `[x]`) if you've completed that task.
72+
-->
73+
74+
* [ ] I have read the comments and followed the PR template.
75+
* [ ] I have provided a explained my PR according to the information in the comments.
76+
* [ ] My PR targets the `develop` branch.

0 commit comments

Comments
 (0)