projects / rustc.git / blame
| Commit | Line | Data |
|---|---|---|
| f20569fa XL |
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 | |
| 064997fb | 6 | explaining your change. |
| f20569fa | 7 | |
| 064997fb FG |
8 | It's also helpful for us that the lint name is put within backticks (`` ` ` ``), |
| 9 | and then encapsulated by square brackets (`[]`), for example: | |
| 10 | ``` | |
| 11 | changelog: [`lint_name`]: your change | |
| 12 | ``` | |
| 13 | ||
| 14 | If your PR fixes an issue, you can add `fixes #issue_number` into this | |
| f20569fa XL |
15 | PR description. This way the issue will be automatically closed when |
| 16 | your PR is merged. | |
| 17 | ||
| 18 | If you added a new lint, here's a checklist for things that will be | |
| 19 | checked during review or continuous integration. | |
| 20 | ||
| 21 | - \[ ] Followed [lint naming conventions][lint_naming] | |
| 22 | - \[ ] Added passing UI tests (including committed `.stderr` file) | |
| 23 | - \[ ] `cargo test` passes locally | |
| 24 | - \[ ] Executed `cargo dev update_lints` | |
| 25 | - \[ ] Added lint documentation | |
| 26 | - \[ ] Run `cargo dev fmt` | |
| 27 | ||
| 28 | [lint_naming]: https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints | |
| 29 | ||
| 30 | Note that you can skip the above if you are just opening a WIP PR in | |
| 31 | order to get feedback. | |
| 32 | ||
| 33 | Delete this line and everything above before opening your PR. | |
| 34 | ||
| 35 | --- | |
| 36 | ||
| 37 | *Please write a short comment explaining your change (or "none" for internal only changes)* | |
| cdc7bbd5 | 38 | |
| f20569fa | 39 | changelog: |