diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/pull_request_template.md similarity index 57% rename from .github/PULL_REQUEST_TEMPLATE/pull_request_template.md rename to .github/pull_request_template.md index fc5da4d..599e907 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,44 +1,26 @@ ---- -name: Pull Request -about: Propose changes to the project -title: '' -labels: '' -assignees: '' - ---- - -## Overview - -Please include a summary of the change and which issue is fixed. Also, include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) +# Overview +Please include a summary of the change and which issue is fixed alongside relevant motivation and context. Also, list any dependencies that are required for this change. ## Type of Change - -Please delete options that are not relevant. - +Please select the options that are relevant. - [ ] 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) - [ ] This change requires a documentation update ## 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 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. ## Checklist: - -- [ ] My code follows the code style of this project. +- [ ] I have followed the code style 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 made corresponding changes to the documentation. -- [ ] My changes generate no new warnings. +- [ ] I have generated 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. -- [ ] Any dependent changes have been merged and published in downstream modules. +- [ ] I have ensured that all tests pass locally with my changes. +- [ ] I have installed the package locally and ensured the package functions properly. +- [ ] I have ensured any dependent changes have been merged and published in downstream modules. ## Additional Information