]> git.lizzy.rs Git - rust.git/blobdiff - CONTRIBUTING.md
Bump to 0.0.137
[rust.git] / CONTRIBUTING.md
index d481cfe0fa90c17dca679b01c87b5b5b74b9e1f8..0b3b48a2cf7fcf038b30d4ff13e2a946ec707092 100644 (file)
@@ -35,15 +35,19 @@ T-middle issues can be more involved and require verifying types. The
 lot of methods that are useful, though one of the most useful would be `expr_ty` (gives the type of
 an AST expression). `match_def_path()` in Clippy's `utils` module can also be useful.
 
-Should you add a lint, try it on clippy itself using `util/dogfood.sh`. You may find that clippy
-contains some questionable code itself! Also before making a pull request, please run
-`util/update_lints.py`, which will update `lib.rs` and `README.md` with the lint declarations. Our
-travis build actually checks for this.
-
-Clippy uses UI tests. UI tests check that the output of the compiler is exactly as expected.
-Of course there's little sense in writing the output yourself or copying it around.
-Therefore you can simply run `tests/ui/update-all-references.sh` and check whether
-the output looks as you expect with `git diff`. Commit all `*.stderr` files, too.
+Compiling clippy can take almost a minute or more depending on your machine.
+You can set the environment flag `CARGO_INCREMENTAL=1` to cut down that time to
+almost a third on average, depending on the influence your change has.
+
+Clippy uses its own version of UI tests. Run `cargo test examples` to run only the ui tests.
+This will update all the `*.stderr` files in `clippy_tests/examples`. You need to check
+the stderr files whether they look as you expected them and commit them together with your
+changes.
+When you want to test a new lint, just create a new file in `clippy_tests/examples` and
+rerun `cargo test examples`.
+
+You can check just one example by running `cargo run --example example_name` inside the
+`clippy_tests` directory.
 
 Also please document your lint with a doc comment akin to the following:
 ```rust