From fa1dd59d3e67a04b8c1663515e0cb9b9a72d5b4c Mon Sep 17 00:00:00 2001 From: Greg Linch Date: Tue, 17 Dec 2019 14:59:40 -0500 Subject: [PATCH] add PR template --- docs/pull_request_template.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/pull_request_template.md diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 0000000..c637d7a --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,35 @@ +[TECH- ](https://industrydive.atlassian.net/browse/TECH-) + +### Non-technical Context + +### Technical Context + +### Reproduction Steps + +### Manual Testing Instructions + +### QA Checklist + +#### Developer + +- [ ] Ensure code complies with the [style guide](https://industrydive.atlassian.net/wiki/spaces/TECH/pages/639500407/Tech+Team+s+Style+Guides) +- [ ] Devise edge cases to test the bug fix or feature being merged +- [ ] Make sure the code is clean and understandable +- [ ] Ensure code is not overly inefficient +- [ ] Ensure documentation is understandable and accurate, including: + - [ ] Code comments and doc strings + - [ ] Technical documentation + + +#### Reviewer + +- [ ] Ensure code complies with the [style guide](https://industrydive.atlassian.net/wiki/spaces/TECH/pages/639500407/Tech+Team+s+Style+Guides) + - If there are few or minor issues, add inline GitHub comments + - If there are many issues or it seems like the developer did not follow the style guide, leave a comment asking them to do so +- [ ] Devise edge cases to test the bug fix or feature being merged +- [ ] Make sure the code is clean and understandable + - [ ] Ask for inline comments on unclear sections +- [ ] Ensure code is not overly inefficient +- [ ] Ensure documentation is understandable and accurate, including: + - [ ] Code comments and doc strings + - [ ] Technical documentation