From b122977c74be0534b8b2ad00460742cc1a6d963e Mon Sep 17 00:00:00 2001 From: mcbarton <150042563+mcbarton@users.noreply.github.com> Date: Wed, 22 May 2024 17:35:05 +0100 Subject: [PATCH 1/2] Added pull_request_template.md --- .github/pull_request_template.md | 35 ++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..89da5576 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +# Description + +Please include a summary of changes, motivation and context for this PR. + +Fixes # (issue) + +## Type of change + +Please tick all options which are relevant. + +- [ ] Bug fix +- [ ] New feature +- [ ] Added/removed dependencies +- [ ] Requires documentation updates + +# Testing + +Please describe the test(s) that you added and ran to verify your changes. + +## Test(s) description + +**Test Configuration**: + +* OS: + +# Checklist: + +- [ ] I have added tests that prove my fix is effective and/or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] I have used understandable variable names +- [ ] I have squashed my commits into a single commit ready for review +- [ ] I have run `git-clang-format HEAD~` on my changes +- [ ] I have made corresponding changes to the documentation +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas From 09a7f08d2c68af75e4020a9a501cfc848845004e Mon Sep 17 00:00:00 2001 From: mcbarton <150042563+mcbarton@users.noreply.github.com> Date: Fri, 31 May 2024 16:17:44 +0100 Subject: [PATCH 2/2] Address comments PR --- .github/pull_request_template.md | 23 +---------------------- 1 file changed, 1 insertion(+), 22 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 89da5576..32987e50 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,25 +11,4 @@ Please tick all options which are relevant. - [ ] Bug fix - [ ] New feature - [ ] Added/removed dependencies -- [ ] Requires documentation updates - -# Testing - -Please describe the test(s) that you added and ran to verify your changes. - -## Test(s) description - -**Test Configuration**: - -* OS: - -# Checklist: - -- [ ] I have added tests that prove my fix is effective and/or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] I have used understandable variable names -- [ ] I have squashed my commits into a single commit ready for review -- [ ] I have run `git-clang-format HEAD~` on my changes -- [ ] I have made corresponding changes to the documentation -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] Required documentation updates