Merge #3443

3443: Document how to lint local Clippy changes with locally built Clippy r=flip1995 a=waynr



Co-authored-by: Wayne Warren <wayne.warren.s@gmail.com>

1 files changed, 12 insertions, 0 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 50f61eb1e67..bb0da592851 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -152,6 +152,18 @@ Manually testing against an example file is useful if you have added some
 local modifications, run `env CLIPPY_TESTS=true cargo run --bin clippy-driver -- -L ./target/debug input.rs`
 from the working copy root.
 
+### Linting Clippy with your changes locally
+
+Clippy CI only passes if all lints defined in the version of the Clippy being
+tested pass (that is, don’t report any suggestions). You can avoid prolonging
+the CI feedback cycle for PRs you submit by running these lints yourself ahead
+of time and addressing any issues found:
+
+```
+cargo build
+`pwd`/target/debug/cargo-clippy clippy --all-targets --all-features -- -D clippy::all -D clippy::internal -D clippy::pedantic
+```
+
 ### How Clippy works
 
 Clippy is a [rustc compiler plugin][compiler_plugin]. The main entry point is at [`src/lib.rs`][main_entry]. In there, the lint registration is delegated to the [`clippy_lints`][lint_crate] crate.