Skip to content

Commit ac93578

Browse files
committed
docs: basics.md: mention lintcheck
1 parent 528e464 commit ac93578

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

doc/basics.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ the codebase take a look at [Adding Lints] or [Common Tools].
1111
- [Get the Code](#get-the-code)
1212
- [Building and Testing](#building-and-testing)
1313
- [`cargo dev`](#cargo-dev)
14-
- [Common Abbreviations](#common-abbreviations)
14+
- [lintcheck](#lintcheck)
1515
- [PR](#pr)
16+
- [Common Abbreviations](#common-abbreviations)
1617

1718
## Get the Code
1819

@@ -91,6 +92,13 @@ cargo dev new_lint
9192
cargo dev ra_setup
9293
```
9394

95+
## lintcheck
96+
`cargo lintcheck` will build and run clippy on a fixed set of crates and generate a log of the results. You can `git diff` the updated log against its previous version and see what impact your lint made on a small set of crates.
97+
If you add a new lint, please audit the resulting warnings and make sure there are no false positives and that the suggestions are valid.
98+
99+
Refer to the tools [README] for more details.
100+
101+
[README]: https://github.com/rust-lang/rust-clippy/blob/master/lintcheck/README.md
94102
## PR
95103

96104
We follow a rustc no merge-commit policy.

0 commit comments

Comments
 (0)