From 93106559f57872de5ccfc7b45b8d5bb22026d7e0 Mon Sep 17 00:00:00 2001 From: LeoKHoward <38526889+LeoKHoward@users.noreply.github.com> Date: Tue, 24 Jun 2025 13:56:30 +0100 Subject: [PATCH 1/8] NPA-4330: Improve PR Template --- .github/pull_request_template.md | 88 ++++++++++++++++++++------------ 1 file changed, 54 insertions(+), 34 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a9a79110..37327ea2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,53 +1,73 @@ -# Pull Request +# Pull Request Template - - -## 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 + + + +- +- +- + +--- + +## ๐Ÿงช How to Test + + + + + + + +- +- +- - +--- -- -- -- +## โœ… 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 + -:information_source: This section is to be filled in by the **reviewer**. +- [ ] 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) -- [ ] 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. From e2d821da9b41065923b01e097a9a255d0e78f39c Mon Sep 17 00:00:00 2001 From: LeoKHoward <38526889+LeoKHoward@users.noreply.github.com> Date: Tue, 24 Jun 2025 13:59:27 +0100 Subject: [PATCH 2/8] NPA-4330: Formatting fix --- .github/pull_request_template.md | 37 ++++++++++++++++---------------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 37327ea2..3f8ed703 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,9 +18,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- -- -- +- +- +- --- @@ -32,9 +32,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- -- -- +- +- +- --- @@ -42,14 +42,14 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- [ ] 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 +- [ ] 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 --- @@ -57,16 +57,17 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- [ ] 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) +- [ ] 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) --- ## ๐Ÿš€ Post-merge + After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman collection workflow. From f783414ccd35080a162a45b6fff18b5ec60909eb Mon Sep 17 00:00:00 2001 From: LeoKHoward <38526889+LeoKHoward@users.noreply.github.com> Date: Tue, 24 Jun 2025 14:12:00 +0100 Subject: [PATCH 3/8] NPA-4330: Testing block added --- .github/pull_request_template.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3f8ed703..8e650f42 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,13 +24,23 @@ Must follow format: `NPA-XXXX: Short Description of the Change` --- -## ๐Ÿงช How to Test +## ๐Ÿงช What Has Been Tested (from the POV of the PR owner) - + + + + +- +- +- + +--- + +## ๐Ÿงช How to Test (from the POV of the reviewer) + + - - - - From 512f4dccf2870d77463be65f605820ef7646ed9e Mon Sep 17 00:00:00 2001 From: LeoKHoward <38526889+LeoKHoward@users.noreply.github.com> Date: Tue, 24 Jun 2025 16:07:40 +0100 Subject: [PATCH 4/8] NPA-4330: formatting fix again --- .github/pull_request_template.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8e650f42..248a7a82 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -57,8 +57,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` - [ ] 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 +- [ ] 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 --- From 652f8201c92f5db162420ed2a5aedba610472830 Mon Sep 17 00:00:00 2001 From: LeoKHoward <38526889+LeoKHoward@users.noreply.github.com> Date: Wed, 25 Jun 2025 08:35:39 +0100 Subject: [PATCH 5/8] NPA-4330: formatting fix again again --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 248a7a82..9d417cd9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -58,8 +58,8 @@ Must follow format: `NPA-XXXX: Short Description of the Change` - [ ] 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 + with + new tests or requirements - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- From fdf30956e7ee65cbcf48725436cfbe71b6ac7aac Mon Sep 17 00:00:00 2001 From: Ellie Bound <175816742+ellie-bound1-NHSD@users.noreply.github.com> Date: Wed, 25 Jun 2025 09:12:47 +0100 Subject: [PATCH 6/8] NPA-4330: Fix formatting --- .github/pull_request_template.md | 44 ++++++++++++++++---------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9d417cd9..caeab75e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,9 +18,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- -- -- +- +- +- --- @@ -30,9 +30,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- -- -- +- +- +- --- @@ -42,9 +42,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- -- -- +- +- +- --- @@ -52,15 +52,15 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- [ ] 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 +- [ ] 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 --- @@ -68,10 +68,10 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- [ ] 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) +- [ ] 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) --- From df50b696f9811d5df46ee05de204c588a8442db5 Mon Sep 17 00:00:00 2001 From: LeoKHoward <38526889+LeoKHoward@users.noreply.github.com> Date: Wed, 25 Jun 2025 09:34:12 +0100 Subject: [PATCH 7/8] NPA-4330: LE suggestion --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index caeab75e..21ebd3de 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -24,7 +24,7 @@ Must follow format: `NPA-XXXX: Short Description of the Change` --- -## ๐Ÿงช What Has Been Tested (from the POV of the PR owner) +## ๐Ÿงช Developer Testing Carried Out @@ -36,7 +36,7 @@ Must follow format: `NPA-XXXX: Short Description of the Change` --- -## ๐Ÿงช How to Test (from the POV of the reviewer) +## ๐Ÿงช Reviewer Testing Required From d422854cc931aaf63fe694166580cc9ed0e2749f Mon Sep 17 00:00:00 2001 From: LeoKHoward <38526889+LeoKHoward@users.noreply.github.com> Date: Wed, 25 Jun 2025 10:37:35 +0100 Subject: [PATCH 8/8] NPA-4330: EB suggestion --- .github/pull_request_template.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 21ebd3de..b7f24655 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ -# Pull Request Template +# Pull Request ## ๐Ÿงพ Ticket Link @@ -30,9 +30,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- -- -- +- [ ] +- [ ] +- [ ] --- @@ -42,9 +42,9 @@ Must follow format: `NPA-XXXX: Short Description of the Change` -- -- -- +- [ ] +- [ ] +- [ ] ---