diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a01e50f728..3de4040763 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,13 @@ *Description here* -Fixes #issue_number +Fixes #**issue_number** +--- **Checklist** -Complete the checklist (and note appropriate exceptions) before a final PR is raised. +Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review. - [ ] Changes are compatible[^1] - [ ] Documentation[^2] completed @@ -22,8 +23,6 @@ Complete the checklist (and note appropriate exceptions) before a final PR is ra **Notes** -[^1]. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. -[^2]. Configuration is an important part of many changes. Where applicable please try to document configuration examples. -[^3]. Tick whichever testing boxes are applicable. If you are adding Manual Tests: - - please document the manual testing (extensively) in the Exceptions. - - please raise a separate issue to automate the test and label it (or ask for it to be labeled) as `manual test` +[^1]: It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. +[^2]: Configuration is an important part of many changes. Where applicable please try to document configuration examples. +[^3]: Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.