From cdd7d3b78666df880118764e5ba49927cf8d52b7 Mon Sep 17 00:00:00 2001 From: Chris Gilmer Date: Fri, 17 Sep 2021 13:55:45 -0700 Subject: [PATCH] Add a PR template to the repo (#9) --- .github/PULL_REQUEST_TEMPLATE.md | 42 ++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..5418b7e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ +Closes #XXX + +## Description + +Explain the changes at a high level. + + + +## Reviewer Notes + +Is there anything you would like reviewers to give additional scrutiny? This is good if you need review of a particular part of the code. + +* Item 1 +* Item 2 + +## Setup + +Add any steps or code to run in this section to help others prepare to run your code: + +```sh +echo "Code goes here" +``` + +Command output: + +```text +output goes here if relevant +``` + +## Code Review Verification Steps + +* [ ] Code submitted includes tests +* [ ] If the change is risky, it has been tested before merging. +* [ ] Documentation was updated + +## References + +* [this link](https://example.com) explains more about the approach used. + +## Screenshots + +If screenshots from the infrastructure or terminal would be helpful in providing context include them here.