Skip to content

Commit

Permalink
Add a PR template to the repo (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgilmerproj committed Sep 17, 2021
1 parent 8cb623b commit cdd7d3b
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
Closes #XXX

## Description

Explain the changes at a high level.

<!-- Any section below this comment can be omitted, but the more detail the better -->

## 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.

0 comments on commit cdd7d3b

Please sign in to comment.