squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Document Clippy strategy

Browse source
This commit is contained in:
Aleksey Kladov 2020-10-02 10:13:58 +02:00
parent 505ff4070a
commit 0599e64bb2
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/dev/style.md
View file

@ -371,3 +371,13 @@ After you are happy with the state of the code, please use [interactive rebase](
Avoid @mentioning people in commit messages and pull request descriptions(they are added to commit message by bors).
Such messages create a lot of duplicate notification traffic during rebases.
# Clippy
We don't enforce Clippy.
A number of default lints have high false positive rate.
Selectively patching false-positives with `allow(clippy)` is considered worse than not using Clippy at all.
There's `cargo xtask lint` command which runs a subset of low-FPR lints.
Careful tweaking of `xtask lint` is welcome.
See also [rust-lang/clippy#5537](https://github.com/rust-lang/rust-clippy/issues/5537).
Of course, applying Clippy suggestions is welcome as long as they indeed improve the code.