diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..6741685 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,53 @@ + + + +## Description + + + +## Motivation and Context + + + +## Types of changes + + +- [ ] CI +- [ ] Docs +- [ ] Feature +- [ ] Fix +- [ ] Performance +- [ ] Refactor +- [ ] Style +- [ ] Test +- [ ] Other (**use sparingly**): + +## Checklists: + + +**Code and Comments** +If this PR includes modifications to the code base, please select all that apply. +- [ ] My code follows the code style of this project. +- [ ] I have updated all package dependencies (if any). +- [ ] I have included all relevant files to realize the functionality of the PR. +- [ ] I have exported relevant functionality (if any). + +**API Documentation** +- [ ] For every exported function (if any), I have included a detailed docstring. +- [ ] I have checked the spelling and grammar of all docstring updates through an external tool. +- [ ] I have checked that the docstring's function signature is correctly formatted and has all arguments. +- [ ] I have checked that the docstring's list of arguments, fields, or return values match the function. +- [ ] I have compiled the docs locally and read through all docstring updates to check for errors. + +**Manual Documentation** +- [ ] I have checked the spelling and grammar of all manual updates through an external tool. +- [ ] Any code included in the docstring is tested using doc tests to ensure consistency. +- [ ] I have compiled the docs locally and read through all manual updates to check for errors. + +**Testing** +- [ ] I have added unit tests to cover my changes. (For Macros, be sure to check + [@code_lowered](https://docs.julialang.org/en/v1/stdlib/InteractiveUtils/#InteractiveUtils.@code_lowered) and + [@code_typed](https://docs.julialang.org/en/v1/stdlib/InteractiveUtils/#InteractiveUtils.@code_typed)) +- [ ] All new and existing tests passed. +- [ ] I have achieved sufficient code coverage. +