diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a9a79110..b7f24655 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,53 +1,85 @@ # Pull Request - - -## Ticket Link +## ๐Ÿงพ Ticket Link https://nhsd-jira.digital.nhs.uk/browse/NPA-XXXX -## Description/Change Summary +--- + +## ๐Ÿ“ PR Title Format + +Must follow format: `NPA-XXXX: Short Description of the Change` + +--- + +## ๐Ÿ“„ Description/Summary of Changes + + + +- +- +- + +--- + +## ๐Ÿงช Developer Testing Carried Out + + + + + +- [ ] +- [ ] +- [ ] + +--- + +## ๐Ÿงช Reviewer Testing Required + + + + + +- [ ] +- [ ] +- [ ] + +--- - +## โœ… Developer Checklist -- -- -- + -## How to test? +- [ ] PR title follows the format: `NPA-XXXX: ` +- [ ] Branch name follows the convention: `/NPA-XXXX-` +- [ ] Commit messages follow the template: `NPA-XXXX: ` +- [ ] All acceptance criteria from the Jira ticket are addressed +- [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated +- [ ] The [traceability matrix](https://nhsd-confluence.digital.nhs.uk/display/NPA/Traceability+matrix) is updated + with + new tests or requirements +- [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added - - - +--- -- -- -- +## ๐Ÿ‘€ Reviewer Checklist - + -## Review Checklist +- [ ] Changes meet the acceptance criteria of the Jira ticket +- [ ] Code is able to be merged (no conflicts and adheres to coding standards) +- [ ] Sufficient test evidence is provided (manual and/or automated) +- [ ] Infrastructure/operational/build changes are validated (if applicable) -:information_source: This section is to be filled in by the **reviewer**. +--- -- [ ] I have reviewed the changes in this PR and they fill all or part of the acceptance criteria of the ticket, and the code is in a mergeable state. -- [ ] If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work. -- [ ] I have ensured the changelog has been updated by the submitter, if necessary. +## ๐Ÿš€ Post-merge -## Post-merge + -After merging and deploying changes to the sandbox, Postman collection or spec examples please run the `Run Postman collection` workflow. +After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman +collection workflow. This will run the tests within the collection to check that the sandbox is working as expected once deployed.