diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..60c7c6d5 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +# Description of PR purpose/changes + +- Please include a summary of the change and which issue is fixed. +- Please also include relevant motivation and context. +- List any dependencies that are required for this change. + +# Jira Ticket / Issue + +e.g. + +- [ ] Added the Jira Ticket to the title of the PR e.g. (DATAUP-69 Adds a PR template) + +# Testing Instructions + +- Details for how to test the PR: +- [ ] Tests pass in Travis-CI, GitHub Actions and locally + +# Dev Checklist: + +- [ ] My code follows the guidelines at +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation, including updating the README with app information changes +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules + +# Updating Version and Release Notes (if applicable) + +- [ ] [Version has been bumped](https://semver.org/) in `kbase.yml` +- [ ] [Release notes](/RELEASE_NOTES.md) have been updated for each release (and during the merge of feature branches)