github.com/Financial-Times/publish-availability-monitor@v1.12.0/.github/pull_request_template.md (about)

     1  # Description
     2  
     3  ## What
     4  
     5  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
     6  
     7  ## Why
     8  
     9  Copy (if there is one) the text of the original Trello/JIRA ticket in here, with a link back to it for the curious.
    10  
    11  ## Anything, in particular, you'd like to highlight to reviewers
    12  
    13  Mention here sections of code which you would like reviewers to pay extra attention to .E.g
    14  
    15  _Would appreciate a second pair of eyes on the test_  
    16  _I am not quite sure how this bit works_  
    17  _Is there a better library for doing x_  
    18  
    19  ## Scope and particulars of this PR (Please tick all that apply)
    20  
    21  - [ ] Tech hygiene (dependency updating & other tech debt)
    22  - [ ] Bug fix
    23  - [ ] Feature
    24  - [ ] Documentation
    25  - [ ] Breaking change
    26  - [ ] Minor change (e.g. fixing a typo, adding config)
    27  
    28  ## DoD - Ensure all relevant tasks are completed before marking this PR as "Ready for review"
    29  
    30  - [ ] Test coverage is not significantly decreased
    31  - [ ] All PR checks have passed
    32  - [ ] Changes are deployed on dev before asking for review
    33  - [ ] Documentations remains up-to-date
    34    - [ ] OpenAPI definition file is updated
    35    - [ ] README file is updated
    36    - [ ] Documentation is updated in upp-docs and upp-public-docs
    37    - [ ] Architecture diagrams are updated
    38  
    39  ___
    40  This Pull Request follows the rules described in our [Pull Requests Guide](https://github.com/Financial-Times/upp-docs/tree/master/guides/pr-guide)