diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7cb3c1f282e8..1b7e75798513 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,30 +1,21 @@ - -### What kind of change does this PR introduce? - - -- [ ] Bugfix -- [ ] Feature -- [ ] Docs -- [ ] New Binding issue #___ -- [ ] Code style update -- [ ] Refactor -- [ ] Build-related changes -- [ ] Other, please describe: +1. Give the PR a descriptive title. -### Does this PR introduce a breaking change? - + Examples of good title: + - fix(windows): fix race condition in event loop + - docs: update docstrings + - feat: add `Window::set_fullscreen` -- [ ] Yes, and the changes were approved in issue #___ -- [ ] No + Examples of bad title: + - fix #7123 + - update docs + - fix bugs -### Checklist -- [ ] When resolving issues, they are referenced in the PR's title (e.g `fix: remove a typo, closes #___, #___`) -- [ ] A change file is added if any packages will require a version bump due to this PR per [the instructions in the readme](https://github.com/tauri-apps/tauri/blob/dev/.changes/readme.md). -- [ ] I have added a convincing reason for adding this feature, if necessary - -### Other information +2. If there is a related issue, reference it in the PR text, e.g. closes #123. +3. If this change requires a new version, then add a change file in `.changes` directory with the appropriate bump, see https://github.com/tauri-apps/tauri/blob/dev/.changes/readme.md +4. Ensure that all your commits are signed https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits +5. Ensure `cargo test` and `cargo clippy` passes. +6. Propose your changes as a draft PR if your work is still in progress. +-->