From e12a018d4aafd6ad9cea04bf45f1e5ff8ba16989 Mon Sep 17 00:00:00 2001 From: JackEAllen Date: Wed, 15 Jan 2025 15:58:15 +0000 Subject: [PATCH 1/3] Update Pull request template Refresh pull request template to make more relevant to current PR workflow and to improve reviewer inclusivity --- .github/pull_request_template.md | 32 ++++++++++++++++++++++---------- 1 file changed, 22 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c8dc15a162f..b18f17466bd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,19 +1,31 @@ -### Issue - -*Close or ref the associated ticket, e.g. Closes #84* + +## Issue Closes # ### Description -*Add a description of the changes made*. + + +### Developer Testing + + +- I have verified unit tests pass locally: `python -m pytest -vs` +- ... -### Testing +### Acceptance Criteria and Reviewer Testing -*Describe the tests that were used to verify your changes*. + +- [ ] Unit tests pass locally: `python -m pytest -vs` +- [ ] ... -### Acceptance Criteria +### Documentation and Additional Notes -*How should the reviewer test your changes*? + -### Documentation + -*How have you changed the documentation to reflect your changes? All changes should be noted in the appropriate file in docs/release_notes* From 6acd8da34f0f339b33f5fe1ed903e3e88974b606 Mon Sep 17 00:00:00 2001 From: JackEAllen Date: Thu, 23 Jan 2025 12:13:47 +0000 Subject: [PATCH 2/3] Update Bug Issue Template Update bug issue template to specify the issue type and reorder the 'Current Behaviour' and 'Expected Behaviour' sub-headers as this is a more natural ordering for developers to write the issue in --- .github/ISSUE_TEMPLATE/bug_report.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 489a6be5377..7e4d4f737c5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,6 +4,7 @@ about: Report an issue that you've encountered. title: '' labels: 'Type: Bug' assignees: '' +type: 'Bug' --- @@ -15,14 +16,14 @@ assignees: '' -### Expected Behaviour - - - ### Current Behaviour +### Expected Behaviour + + + ### Context From a27a3f743e1c61b8adae685d05ed7cb3e44c0b0a Mon Sep 17 00:00:00 2001 From: JackEAllen Date: Thu, 23 Jan 2025 12:18:38 +0000 Subject: [PATCH 3/3] Update Feature Template Update feature issue template to specify the issue type as 'Feature' and to add some additional sub-headings to improve issue context and inclusivity of issue for new developers. The 'Importance of Feature' sub-heading has been added to help improve issue prioritisation by allowing developers to write a brief description of the importance of the issue and why it needs to be worked on --- .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index a1f258592d9..9bb97aac846 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,13 +4,26 @@ about: Request an improvement or a new feature. title: '' labels: 'Type: Improvement' assignees: '' +type: 'Feature' --- +### Current Behaviour + + + ### Desired Behaviour -### Current Behaviour +### Undesired Behaviour - + + +### Importance of Feature + + + +### Additional Context + + \ No newline at end of file