diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..18c72e0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ + +--- + +### Acceptance Checklist + +- [ ] **Story**: Code is focused on the linked stories and solves a problem +- One of: + - [ ] **For Bugs**: A unit test is added or an existing one modified + - [ ] **For Features**: New unit tests are added covering the new functions or modifications +- [ ] Code Documentation changes are included for public interfaces and important / complex additions +- [ ] External Documentation is included for API changes, or other external facing interfaces + +### Review Checklist + +- [ ] The code does not duplicate existing functionality that exists elsewhere +- [ ] The code has been linted and follows team practices and style guidelines +- [ ] The changes in the PR are relevant to the title + - changes not related should be moved to a different PR +- [ ] All errors or error handling is actionable, and informs the viewer on how to correct it