Skip to content

Commit a056f80

Browse files
authored
Create pull_request_template.md
This adds a new template for pull requests which asks the user provide more details.
1 parent 6cbb703 commit a056f80

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

.github/pull_request_template.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!-- Use this template by filling in information and copy and pasting relevant items out of the html comments. -->
2+
3+
# Relates to:
4+
<!-- LINK TO ISSUE OR TICKET -->
5+
6+
<!-- This risks section is to be filled out before final review and merge. -->
7+
# Risks
8+
<!--
9+
Low, medium, large. List what kind of risks, and what could be effected.
10+
-->
11+
12+
# Background
13+
## What does this PR do?
14+
15+
## What kind of change is this?
16+
<!--
17+
Bug fixes (non-breaking change which fixes an issue)
18+
Improvements (misc. changes to existing features)
19+
Features (non-breaking change which adds functionality)
20+
Updates (new versions of included code)
21+
-->
22+
23+
<!-- This "Why" section is most relevant if there is no linked issue explaining why. If there is a related issue it might make sense to skip this why section. -->
24+
<!--
25+
## Why are we doing this? Any context or related work?
26+
-->
27+
28+
# Documentation changes needed?
29+
<!--
30+
My changes do not require a change to the project documentation.
31+
My changes require a change to the project documentation.
32+
If a docs change is needed: I have updated the documentation accordingly.
33+
-->
34+
35+
<!-- Please show how you tested the PR. This will really help if the PR needs to be retested, and probably help the PR get merged quicker. -->
36+
# Testing
37+
## Where should a reviewer start?
38+
39+
## Detailed testing steps
40+
<!--
41+
None, automtated tests are fine.
42+
-->
43+
44+
<!--
45+
- As [anon/admin], go to [link]
46+
  - [do action]
47+
  - verify [result]
48+
-->
49+
50+
<!-- If there is a UI change, please include before and after screenshots or videos. This will speed up PRs being merged. It is extra nice to annotate screenshots with arrows or boxes pointing out the differences. -->
51+
<!--
52+
## Screenshots
53+
### Before
54+
### After
55+
-->
56+
57+
<!-- If there is anything about the deploy, please make a note. -->
58+
<!--
59+
# Deploy Notes
60+
-->
61+
62+
<!--  Copy and paste commandline output. -->
63+
<!--
64+
## Database changes
65+
-->
66+
67+
<!--  If there is something more than the automated steps, please specifiy deploy instructions. -->
68+
<!--
69+
## Deployment instructions
70+
-->

0 commit comments

Comments
 (0)