diff options
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE | 28 | ||||
| -rw-r--r-- | doc/adding_lints.md | 1 |
2 files changed, 29 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 00000000000..5567b84b3f5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,28 @@ +<!-- +Thank you for making Clippy better! + +We're collecting our changelog from pull request descriptions. +If your PR only updates to the latest nightly, you can leave the +`changelog` entry as `none`. Otherwise, please write a short comment +explaining your change. + +If your PR fixes an issue, you can add "fixes #issue_number" into this +PR description. This way the issue will be automatically closed when +your PR is merged. + +If you added a new lint, here's a checklist for things that will be +checked during review or continuous integration. + +- [ ] Followed [lint naming conventions][lint_naming] +- [ ] Added passing UI tests (including committed `.stderr` file) +- [ ] `cargo test` passes locally +- [ ] Executed `util/dev update_lints` +- [ ] Added lint documentation +- [ ] Run `cargo fmt` + +Note that you can skip the above if you are just opening a WIP PR in +order to get feedback. + +Delete this line and everything above before opening your PR --> + +changelog: none diff --git a/doc/adding_lints.md b/doc/adding_lints.md index a45551dbf9c..d78e9c28e77 100644 --- a/doc/adding_lints.md +++ b/doc/adding_lints.md @@ -394,6 +394,7 @@ Before submitting your PR make sure you followed all of the basic requirements: - [ ] `cargo test` passes locally - [ ] Executed `util/dev update_lints` - [ ] Added lint documentation +- [ ] Run `cargo fmt` ### Cheatsheet |