diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..09a19adf --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ + + +
+ PR Checklist + +### PR Structure + +* [ ] This PR has reasonably narrow scope (if not, break it down into smaller PRs). +* [ ] This PR avoids mixing refactoring changes with feature changes (split into two PRs + otherwise). +* [ ] This PR's title starts with the jira ticket associated with the PR. + +### Thoroughness + +* [ ] This PR adds tests for the most critical parts of the new functionality or fixes. +* [ ] I've updated the README with the added features, breaking changes, new instructions on how to use the repository. I updated the description of the fuction with the changes that were made. + +### Release planning + +* [ ] I've decided if this PR requires a new major/minor/patch version accordingly to + [semver](https://semver.org/), and I've changed the name of the BRANCH to release/* , feature/* or patch/* . +
+ +### What + +[TODO: Short statement about what is changing.] + +### Why + +[TODO: Why this change is being made. Include any context required to understand the why.] + +### Known limitations + +[TODO or N/A]