rust-clippy/.github/PULL_REQUEST_TEMPLATE.md

40 lines
1.3 KiB
Markdown
Raw Normal View History

2019-04-16 09:04:42 +00:00
Thank you for making Clippy better!
We're collecting our changelog from pull request descriptions.
If your PR only includes internal changes, you can just write
`changelog: none`. Otherwise, please write a short comment
explaining your change.
2019-04-16 09:04:42 +00:00
It's also helpful for us that the lint name is put within backticks (`` ` ` ``),
and then encapsulated by square brackets (`[]`), for example:
```
changelog: [`lint_name`]: your change
```
If your PR fixes an issue, you can add `fixes #issue_number` into this
2019-04-16 09:04:42 +00:00
PR description. This way the issue will be automatically closed when
your PR is merged.
2019-04-16 11:30:46 +00:00
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 `cargo dev update_lints`
- \[ ] Added lint documentation
- \[ ] Run `cargo dev fmt`
[lint_naming]: https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints
2019-04-16 13:15:19 +00:00
Note that you can skip the above if you are just opening a WIP PR in
order to get feedback.
2019-04-16 11:30:46 +00:00
Delete this line and everything above before opening your PR.
---
2019-04-16 09:04:42 +00:00
*Please write a short comment explaining your change (or "none" for internal only changes)*
changelog: