diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e69de29..98eb076 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,43 @@ +### Description + +Please include a summary of the changes and the related issue. Also, mention the motivation behind this PR and any context that will help the reviewers understand it better. + +Fixes # (issue) + +### Type of change + +Please delete options that are not 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) +- [ ] Documentation update +- [ ] Other (please describe): + +### How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so reviewers can reproduce them. List any relevant details for your test configuration. + +- [ ] Unit tests +- [ ] Integration tests +- [ ] End-to-end tests +- [ ] Manual tests + +### 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 made corresponding changes to the documentation. +- [ ] 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. +- [ ] Any dependent changes have been merged and published in downstream modules. + +### Screenshots (if applicable): + +If there are any visual changes, please add screenshots or gifs here. + +### Additional context + +Add any other context or information that reviewers may need to know about your PR here.