CONTRIBUTING.md

   1 # Contributing to rust-clippy
   2
   3 Hello fellow Rustacean! Great to see your interest in compiler internals and lints!
   4
   5 ## Getting started
   6
   7 High level approach:
   8
   9 1. Find something to fix/improve
  10 2. Change code (likely some file in `clippy_lints/src/`)
  11 3. Run `cargo test` in the root directory and wiggle code until it passes
  12 4. Open a PR (also can be done between 2. and 3. if you run into problems)
  13
  14 ### Finding something to fix/improve
  15
  16 All issues on Clippy are mentored, if you want help with a bug just ask @Manishearth, @llogiq, @mcarton or @oli-obk.
  17
  18 Some issues are easier than others. The [`good first issue`](https://github.com/rust-lang-nursery/rust-clippy/labels/good%20first%20issue)
  19 label can be used to find the easy issues. If you want to work on an issue, please leave a comment
  20 so that we can assign it to you!
  21
  22 Issues marked [`T-AST`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-AST) involve simple
  23 matching of the syntax tree structure, and are generally easier than
  24 [`T-middle`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-middle) issues, which involve types
  25 and resolved paths.
  26
  27 [`T-AST`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-AST) issues will generally need you to match against a predefined syntax structure. To figure out
  28 how this syntax structure is encoded in the AST, it is recommended to run `rustc -Z ast-json` on an
  29 example of the structure and compare with the
  30 [nodes in the AST docs](http://manishearth.github.io/rust-internals-docs/syntax/ast/). Usually
  31 the lint will end up to be a nested series of matches and ifs,
  32 [like so](https://github.com/rust-lang-nursery/rust-clippy/blob/de5ccdfab68a5e37689f3c950ed1532ba9d652a0/src/misc.rs#L34).
  33
  34 [`E-medium`](https://github.com/rust-lang-nursery/rust-clippy/labels/E-medium) issues are generally
  35 pretty easy too, though it's recommended you work on an E-easy issue first. They are mostly classified
  36 as `E-medium`, since they might be somewhat involved code wise, but not difficult per-se.
  37
  38 [`T-middle`](https://github.com/rust-lang-nursery/rust-clippy/labels/T-middle) issues can
  39 be more involved and require verifying types. The
  40 [`ty`](http://manishearth.github.io/rust-internals-docs/rustc/ty) module contains a
  41 lot of methods that are useful, though one of the most useful would be `expr_ty` (gives the type of
  42 an AST expression). `match_def_path()` in Clippy's `utils` module can also be useful.
  43
  44 ### Writing code
  45
  46 Compiling clippy from scratch can take almost a minute or more depending on your machine.
  47 However, since Rust 1.24.0 incremental compilation is enabled by default and compile times for small changes should be quick.
  48
  49 [Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is a nice primer
  50 to lint-writing, though it does get into advanced stuff. Most lints consist of an implementation of
  51 `LintPass` with one or more of its default methods overridden. See the existing lints for examples
  52 of this.
  53
  54 Please document your lint with a doc comment akin to the following:
  55
  56 ```rust
  57 /// **What it does:** Checks for ... (describe what the lint matches).
  58 ///
  59 /// **Why is this bad?** Supply the reason for linting the code.
  60 ///
  61 /// **Known problems:** None. (Or describe where it could go wrong.)
  62 ///
  63 /// **Example:**
  64 ///
  65 /// ```rust
  66 /// // Bad
  67 /// Insert a short example of code that triggers the lint
  68 ///
  69 /// // Good
  70 /// Insert a short example of improved code that doesn't trigger the lint
  71 /// ```
  72 ```
  73
  74 ### Running test suite
  75
  76 Clippy uses UI tests. UI tests check that the output of the compiler is exactly as expected.
  77 Of course there's little sense in writing the output yourself or copying it around.
  78 Therefore you can simply run `tests/ui/update-all-references.sh` (after running
  79 `cargo test`) and check whether the output looks as you expect with `git diff`. Commit all
  80 `*.stderr` files, too.
  81
  82 If you don't want to wait for all tests to finish, you can also execute a single test file by using `TESTNAME` to specify the test to run:
  83
  84 ```bash
  85 TESTNAME=ui/empty_line_after_outer_attr cargo test --test compile-test
  86 ```
  87
  88 ### Testing manually
  89
  90 Manually testing against an example file is useful if you have added some
  91 `println!`s and test suite output becomes unreadable.  To try clippy with your
  92 local modifications, run `cargo run --bin clippy-driver -- -L ./target/debug input.rs` from the
  93 working copy root. Your test file, here `input.rs`, needs to have clippy
  94 enabled as a plugin:
  95
  96 ```rust
  97 #![feature(plugin)]
  98 #![plugin(clippy)]
  99 ```
 100
 101 ## Contributions
 102
 103 Clippy welcomes contributions from everyone.
 104
 105 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
 106 be reviewed by a core contributor (someone with permission to land patches) and either landed in the
 107 main tree or given feedback for changes that would be required.
 108
 109 All code in this repository is under the [Mozilla Public License, 2.0](https://www.mozilla.org/MPL/2.0/)
 110
 111 ## Conduct
 112
 113 We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
 114
 115
 116 <!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->