Skip to content

Commit 4b91306

Browse files
committed
Added new pull request template
1 parent 4be33ac commit 4b91306

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

.github/pull_request_template.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!-- PR TITLE: Your title should be a concise 1-liner of the changeset, including an issue number if relevant
2+
-->
3+
4+
<!--
5+
Please do NOT erase parts of this template in your PR description.
6+
If your change is a one-line config change, the answers to the
7+
questions below may be very, very light, but that's ok.
8+
-->
9+
10+
### What's the problem being solved?
11+
12+
_[Why are these changes necessary? What is the problem that we're trying to solve?]_
13+
14+
### How is the problem being solved?
15+
16+
_[What changed, broadly speaking? This is NOT a file change breakdown, that's for the diffs. Instead just identify broadly what was added, removed, or changed.]_
17+
18+
### How can I test that the problem was solved?
19+
20+
_[How does a reviewer test that new things work and old things didn't break? The answer is not just "run the tests" - that's what Jenkins is for. Rather, write what tests were added or updated; did we add a regression test, for example? Or perhaps the reviewer should open the UI and click something to test this?]_
21+
22+
### Reviewer Checklist
23+
24+
This checklist is for the reviewer to complete.
25+
26+
I (the reviewer) have checked that the:
27+
28+
- [ ] PR title and description are accurate
29+
- [ ] code is complete, correct, and adheres to guidelines
30+
- [ ] tests are accurate and cover conditions sufficiently
31+
- [ ] code runs and meets the ticket acceptance criteria
32+
- [ ] software dependencies have been updated
33+
- [ ] documentation has been updated, if necessary

0 commit comments

Comments
 (0)