diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..49e36e35b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ +## Proposed change + +<!-- +Please include a summary of the change and which issue is fixed (if any) and any relevant motivation / context. List any dependencies that are required for this change. If appropriate, please include an explanation of how your poposed change can be tested. Screenshots and / or videos can also be helpful if appropriate. +--> + +Fixes # (issue) + +<!-- +Please also tag the relevant team to help with review. You can tag any of the following: +@paperless-ngx/backend (Python / django, database, etc.) +@paperless-ngx/frontend (JavaScript/Typescript, HTML, CSS, etc.) +@paperless-ngx/ci-cd (GitHub Actions, deployment) +@paperless-ngx/test (General testing for larger PRs) +--> + +## Type of change + +<!-- +What type of change does your PR introduce to Paperless-ngx? +NOTE: Please check only one box! +--> + +- [ ] 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) +- [ ] Other (please explain) + +## Checklist: + +- [ ] I have read & agree with the [contributing guidelines](https://github.com/paperless-ngx/paperless-ngx/blob/main/CONTRIBUTING.md). +- [ ] If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers. +- [ ] If applicable, I have checked that all tests pass, see [documentation](https://paperless-ngx.readthedocs.io/en/latest/extending.html#back-end-development). +- [ ] I have run all `pre-commit` hooks, see [documentation](https://paperless-ngx.readthedocs.io/en/latest/contributing.html#pre-commit-hooks). +- [ ] I have made corresponding changes to the documentation as needed. +- [ ] I have checked my modifications for any breaking changes.