diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..8518db2 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,29 @@ +# Description + +## What + +Please be specific and try to describe your thought process. State the obvious, since this might be the first time the reviewer is looking at the code + +## Why + +Copy (if there is one) the text of the original Trello/JIRA ticket in here, with a link back to it for the curious. + +## Anything, in particular, you'd like to highlight to reviewers + +Mention here sections of code which you would like reviewers to pay extra attention to .E.g + +_Would appreciate a second pair of eyes on the test_ +_I am not quite sure how this bit works_ +_Is there a better library for doing x_ + +## Scope and particulars of this PR (Please tick all that apply) + +- [ ] Tech hygiene (dependency updating & other tech debt) +- [ ] Bug fix +- [ ] Feature +- [ ] Documentation +- [ ] Breaking change +- [ ] Minor change (e.g. fixing a typo, adding config) + +___ +This Pull Request follows the rules described in our [Pull Requests Guide](https://github.com/Financial-Times/upp-docs/tree/master/guides/pr-guide)