-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c286b26
commit 2c0317c
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# 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) | ||
|
||
## DoD - Ensure all relevant tasks are completed before marking this PR as "Ready for review" | ||
|
||
- [ ] Test coverage is not significantly decreased | ||
- [ ] All PR checks have passed | ||
- [ ] Changes are deployed on dev before asking for review | ||
- [ ] Documentations remains up-to-date | ||
- [ ] OpenAPI definition file is updated | ||
- [ ] README file is updated | ||
- [ ] Documentation is updated in upp-docs and upp-public-docs | ||
- [ ] Architecture diagrams are updated | ||
|
||
___ | ||
This Pull Request follows the rules described in our [Pull Requests Guide](https://github.com/Financial-Times/upp-docs/tree/master/guides/pr-guide) |