From 449bca51a10e845f8b4c7a25636621ae77ebac6a Mon Sep 17 00:00:00 2001 From: electron271 <66094410+electron271@users.noreply.github.com> Date: Tue, 27 Aug 2024 22:14:05 -0500 Subject: [PATCH 1/3] Update PULL_REQUEST_TEMPLATE.md change stuff that isnt actually in tux and clarify stuff --- .github/PULL_REQUEST_TEMPLATE.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index de4ddebc8..adf586a2a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,6 @@ -# Pull Request Template - ## Description -Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. If this change fixes any issues please put "Fixes #XX" in the description. ## Type of Change @@ -12,24 +8,21 @@ Fixes # (issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Documentation update +- [ ] Other: (write here) ## Checklist -- [ ] My code follows the style guidelines of this project +- [ ] My code follows the style guidelines of this project (formatted with Ruff) - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation +- [ ] I have made corresponding changes to the documentation if needed - [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes +- [ ] I have tested this change - [ ] Any dependent changes have been merged and published in downstream modules ## How Has This Been Tested? -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. - -- [ ] Test A -- [ ] Test B +Please describe how you tested your code. e.g describe what commands you ran, what arguments, and any config stuff (if applicable) ## Screenshots (if applicable) From 8223b73fcfe7fdf3bc5d3be37109c8a69ba13915 Mon Sep 17 00:00:00 2001 From: electron271 <66094410+electron271@users.noreply.github.com> Date: Tue, 27 Aug 2024 22:15:07 -0500 Subject: [PATCH 2/3] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index adf586a2a..0e70d0330 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,7 +20,7 @@ Please include a summary of the changes and the related issue. Please also inclu - [ ] I have tested this change - [ ] Any dependent changes have been merged and published in downstream modules -## How Has This Been Tested? +## How Has This Been Tested? (if applicable) Please describe how you tested your code. e.g describe what commands you ran, what arguments, and any config stuff (if applicable) From 0acc5054df71dedea60b0ece63d04ec154238747 Mon Sep 17 00:00:00 2001 From: electron271 <66094410+electron271@users.noreply.github.com> Date: Wed, 28 Aug 2024 11:26:48 -0500 Subject: [PATCH 3/3] Update PULL_REQUEST_TEMPLATE.md make guideline checking less time consuming --- .github/PULL_REQUEST_TEMPLATE.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0e70d0330..a87973281 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,15 +10,17 @@ Please include a summary of the changes and the related issue. Please also inclu - [ ] Documentation update - [ ] Other: (write here) -## Checklist - -- [ ] My code follows the style guidelines of this project (formatted with Ruff) -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation if needed -- [ ] My changes generate no new warnings -- [ ] I have tested this change -- [ ] Any dependent changes have been merged and published in downstream modules +## Guidelines + +- My code follows the style guidelines of this project (formatted with Ruff) +- I have performed a self-review of my own code +- I have commented my code, particularly in hard-to-understand areas +- I have made corresponding changes to the documentation if needed +- My changes generate no new warnings +- I have tested this change +- Any dependent changes have been merged and published in downstream modules + +- [ ] I have followed all of these guidelines. ## How Has This Been Tested? (if applicable)