]> git.lizzy.rs Git - rust.git/blob - .github/PULL_REQUEST_TEMPLATE.md
Merge commit 'd7b5cbf065b88830ca519adcb73fad4c0d24b1c7' into clippyup
[rust.git] / .github / PULL_REQUEST_TEMPLATE.md
1 Thank you for making Clippy better!
2
3 We're collecting our changelog from pull request descriptions.
4 If your PR only includes internal changes, you can just write
5 `changelog: none`. Otherwise, please write a short comment
6 explaining your change. Also, it's helpful for us that
7 the lint name is put into brackets `[]` and backticks `` ` ` ``,
8 e.g. ``[`lint_name`]``.
9
10 If your PR fixes an issue, you can add "fixes #issue_number" into this
11 PR description. This way the issue will be automatically closed when
12 your PR is merged.
13
14 If you added a new lint, here's a checklist for things that will be
15 checked during review or continuous integration.
16
17 - \[ ] Followed [lint naming conventions][lint_naming]
18 - \[ ] Added passing UI tests (including committed `.stderr` file)
19 - \[ ] `cargo test` passes locally
20 - \[ ] Executed `cargo dev update_lints`
21 - \[ ] Added lint documentation
22 - \[ ] Run `cargo dev fmt`
23
24 [lint_naming]: https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints
25
26 Note that you can skip the above if you are just opening a WIP PR in
27 order to get feedback.
28
29 Delete this line and everything above before opening your PR.
30
31 ---
32
33 *Please write a short comment explaining your change (or "none" for internal only changes)*
34
35 changelog: