Skip to content

Commit d683258

Browse files
author
Gabe
authored
Create pull_request_template.md
1 parent 6eb9fb1 commit d683258

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# [Replace Me With Meaningful Name] - #[Issue]
2+
3+
## Description
4+
5+
Include a summary of the change and which issue it addresses in the title of the PR.
6+
7+
Include relevant motivation, context, brief description and impact of the change(s). List follow-up tasks here.
8+
9+
## How Has This Been Tested?
10+
11+
Describe the tests that you ran to verify your changes. Provide instructions for reproduction.
12+
13+
- [ ] Test A (e.g. Test A - New test that ... ran in local, docker, and dev unstable.)
14+
- [ ] Test B
15+
16+
## Definition of Done
17+
18+
Before submitting this PR, please make sure:
19+
20+
- [ ] The work addresses the description and outcomes in the issue
21+
- [ ] I have added relevant tests for new or updated functionality
22+
- [ ] My code follows conventions, is well commented, and easy to understand
23+
- [ ] My code builds and tests pass without any errors or warnings
24+
- [ ] I have tagged the relevant reviewers
25+
- [ ] I have updated the READMEs of affected packages
26+
- [ ] I have made corresponding changes to the documentation
27+
- [ ] The changes have been communicated to interested parties
28+
29+
## References:
30+
31+
Please list relevant documentation (e.g. tech specs, articles, related work etc.) relevant to this change, and note if the documentation has been updated.

0 commit comments

Comments
 (0)