From 527941e40c21502cc7d12f6fc6655a5af4cb3cdf Mon Sep 17 00:00:00 2001 From: Alan Liddell Date: Fri, 13 Oct 2023 11:07:57 -0400 Subject: [PATCH 1/2] add PR template --- .github/pull_request_template.md | 56 ++++++++++++++++++++++++++++++++ 1 file changed, 56 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 0000000..b3ccd0a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,56 @@ +# Description + +*Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.* + +## Related Issue(s) + +- Issue: # +- See also: + - # + +## Type of change + +- [ ] Bug fix (non-breaking change which fixes an 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 +- [ ] Other (please describe): + +# Changes + +## Added + +- + +## Changed + +- + +## Deprecated + +- + +## Removed + +- + +## Fixed + +- + +## Security + +- + +# How has this been tested? + +*Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.* + +# Checklist + +- [ ] My code follows the style guidelines of this project. +- [ ] I have performed a self-review of my own code. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have updated the documentation, if necessary. +- [ ] I added tests for my changes, and/or the testing strategy is described above. +- [ ] I updated the [changelog](../CHANGELOG.md). \ No newline at end of file From 8e546d6a95fa6a1c104006c75a5b8f3c673fb09e Mon Sep 17 00:00:00 2001 From: Alan Liddell Date: Tue, 17 Oct 2023 15:26:34 -0400 Subject: [PATCH 2/2] Address PR comments. --- .github/pull_request_template.md | 29 +---------------------------- 1 file changed, 1 insertion(+), 28 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b3ccd0a..550020a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,7 @@ *Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.* -## Related Issue(s) +## Related issue(s) - Issue: # - See also: @@ -16,39 +16,12 @@ - [ ] Documentation - [ ] Other (please describe): -# Changes - -## Added - -- - -## Changed - -- - -## Deprecated - -- - -## Removed - -- - -## Fixed - -- - -## Security - -- - # How has this been tested? *Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.* # Checklist -- [ ] My code follows the style guidelines of this project. - [ ] I have performed a self-review of my own code. - [ ] I have commented my code, particularly in hard-to-understand areas. - [ ] I have updated the documentation, if necessary.