diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index ec9ec5cb..7cbca0f4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,9 @@ + + ## Description - + ## Related Issue @@ -9,20 +13,30 @@ Fixes #(issue number) - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) +- [ ] Refactor (no functional change) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update +- [ ] Documentation update + +## Testing + +- [ ] I added or updated tests covering my changes +- [ ] Existing tests pass locally (`uv run pytest -m "cpu and not slow"`) -## How Has This Been Tested? - +For full setup and testing instructions, see the +[Contributing Guide](https://docs.pruna.ai/en/stable/docs_pruna/contributions/how_to_contribute.html). ## 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 -- [ ] 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 - -## Additional Notes - +- [ ] I have performed a self-review of my code +- [ ] I updated the documentation where necessary + +--- + +Thanks for contributing to **Pruna**! We're excited to review your work. + +New to contributing? Check out our +[Contributing Guide](https://docs.pruna.ai/en/stable/docs_pruna/contributions/how_to_contribute.html) for everything you need to get started. + +> **Note:** Draft PRs or PRs without sufficient description may be delayed. +> Please mark your PR as **Ready for Review** and ensure the sections above are filled out. \ No newline at end of file