Skip to content

Commit 9310655

Browse files
committed
NPA-4330: Improve PR Template
1 parent fe78aa2 commit 9310655

File tree

1 file changed

+54
-34
lines changed

1 file changed

+54
-34
lines changed

.github/pull_request_template.md

Lines changed: 54 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,73 @@
1-
# Pull Request
1+
# Pull Request Template
22

3-
<!--
4-
Stages to complete before opening the Pull Request:
5-
- PR title should be formatted in the following structure `NPA-XXXXX: title abc`
6-
- Added yourself/others as Assignees
7-
- Added the correct labels
8-
- Add Jira ticket link in the Ticket Link section below
9-
-->
10-
11-
## Ticket Link
3+
## 🧾 Ticket Link
124

135
<!-- Add the Jira ticket link here -->
146

157
https://nhsd-jira.digital.nhs.uk/browse/NPA-XXXX
168

17-
## Description/Change Summary
9+
---
10+
11+
## 📝 PR Title Format
12+
13+
Must follow format: `NPA-XXXX: Short Description of the Change`
14+
15+
---
16+
17+
## 📄 Description/Summary of Changes
18+
19+
<!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes -->
20+
21+
- <!-- Add bullet points summarising key changes -->
22+
- <!-- Add bullet points summarising key changes -->
23+
- <!-- Add bullet points summarising key changes -->
24+
25+
---
26+
27+
## 🧪 How to Test
28+
29+
<!-- Describe how to test the changes. Include: -->
30+
<!-- - Testing environment details (e.g. sandbox/local setup) -->
31+
<!-- - Steps to verify the changes -->
32+
<!-- - Any automated tests added or updated (with links to test cases if applicable) -->
33+
<!-- - Evidence that each acceptance criterion from the Jira ticket is met -->
34+
35+
- <!-- Add bullet points for testing instructions -->
36+
- <!-- Add bullet points for testing instructions -->
37+
- <!-- Add bullet points for testing instructions -->
1838

19-
<!-- Describe the changes made in this PR -->
39+
---
2040

21-
-
22-
-
23-
-
41+
## ✅ Developer Checklist
2442

25-
## How to test?
43+
<!-- Complete before submitting the PR -->
2644

27-
<!--- Describe in detail how you tested your changes -->
28-
<!--- Include details of your testing environment and the tests you ran to see how your change affects other areas of the code etc. -->
29-
<!--- Are there any automated tests that mean changes don't need to be manually changed? -->
45+
- [ ] PR title follows the format: `NPA-XXXX: <short-description>`
46+
- [ ] Branch name follows the convention: `<type>/NPA-XXXX-<short-description>`
47+
- [ ] Commit messages follow the template: `NPA-XXXX: <short-description>`
48+
- [ ] All acceptance criteria from the Jira ticket are addressed
49+
- [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated
50+
- [ ] The [traceability matrix](https://nhsd-confluence.digital.nhs.uk/display/NPA/Traceability+matrix) is updated with
51+
new tests or requirements
52+
- [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added
3053

31-
-
32-
-
33-
-
54+
---
3455

35-
<!--
36-
Stages to complete before opening the Pull Request:
37-
- PR title should be formatted in the following structure `NPA-XXXXX: title abc`
38-
- Added yourself/others as Assignees
39-
-->
56+
## 👀 Reviewer Checklist
4057

41-
## Review Checklist
58+
<!-- To be completed by the reviewer -->
4259

43-
:information_source: This section is to be filled in by the **reviewer**.
60+
- [ ] Changes meet the acceptance criteria of the Jira ticket
61+
- [ ] Code is able to be merged (no conflicts and adheres to coding standards)
62+
- [ ] Sufficient test evidence is provided (manual and/or automated)
63+
- [ ] Infrastructure/operational/build changes are validated (if applicable)
4464

45-
- [ ] 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.
46-
- [ ] If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work.
47-
- [ ] I have ensured the changelog has been updated by the submitter, if necessary.
65+
---
4866

49-
## Post-merge
67+
## 🚀 Post-merge
5068

51-
After merging and deploying changes to the sandbox, Postman collection or spec examples please run the `Run Postman collection` workflow.
69+
<!-- Actions to complete after merging -->
70+
After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman
71+
collection workflow.
5272

5373
This will run the tests within the collection to check that the sandbox is working as expected once deployed.

0 commit comments

Comments
 (0)