diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8be0692 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,37 @@ +# Pull Request + +## Description + +Please include a summary of the changes and the motivation behind them. If applicable, link to any related issues. + +## Type of Change + +Please check the type of change your PR introduces: + +- [ ] Bugfix +- [ ] New feature +- [ ] Enhancement +- [ ] Documentation +- [ ] Refactoring +- [ ] Other (please specify): + +## Checklist + +- [ ] I have read the [contributing guidelines](CONTRIBUTING.md). +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] I have updated the documentation accordingly. +- [ ] I ran `black` formatter on the codebase. (CI/CD will fail if neglected) +- [ ] My code follows the project's coding style guidelines. + +## Related Issues + +- Closes # (issue number) +- Related to # (issue number) + +## Screenshots (if applicable) + +If your change includes visual updates, please include screenshots to demonstrate the changes. + +## Additional Notes + +Add any additional notes or comments here. For example, describe any known issues or limitations.