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](https://doc.rust-lang.org/nightly/nightly-rustc/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`](https://doc.rust-lang.org/nightly/nightly-rustc/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
  55 #### Author lint
  56
  57 There is also the internal `author` lint to generate clippy code that detects the offending pattern. It does not work for all of the Rust syntax, but can give a good starting point.
  58
  59 Create a new UI test with the pattern you want to match:
  60
  61 ```rust
  62 // ./tests/ui/my_lint.rs
  63
  64 // The custom_attribute needs to be enabled for the author lint to work
  65 #![feature(plugin, custom_attribute)]
  66
  67 fn main() {
  68     #[clippy(author)]
  69     let arr: [i32; 1] = [7]; // Replace line with the code you want to match
  70 }
  71 ```
  72
  73 Now you run `TESTNAME=ui/my_lint cargo test --test compile-test` to produce
  74 the file with the generated code:
  75
  76 ```rust
  77 // ./tests/ui/my_lint.stdout
  78
  79 if_chain! {
  80     if let Expr_::ExprArray(ref elements) = stmt.node;
  81     if elements.len() == 1;
  82     if let Expr_::ExprLit(ref lit) = elements[0].node;
  83     if let LitKind::Int(7, _) = lit.node;
  84     then {
  85         // report your lint here
  86     }
  87 }
  88 ```
  89
  90 #### Documentation
  91
  92 Please document your lint with a doc comment akin to the following:
  93
  94 ```rust
  95 /// **What it does:** Checks for ... (describe what the lint matches).
  96 ///
  97 /// **Why is this bad?** Supply the reason for linting the code.
  98 ///
  99 /// **Known problems:** None. (Or describe where it could go wrong.)
 100 ///
 101 /// **Example:**
 102 ///
 103 /// ```rust
 104 /// // Bad
 105 /// Insert a short example of code that triggers the lint
 106 ///
 107 /// // Good
 108 /// Insert a short example of improved code that doesn't trigger the lint
 109 /// ```
 110 ```
 111
 112 Once your lint is merged it will show up in the [lint list](https://rust-lang-nursery.github.io/rust-clippy/master/index.html)
 113
 114 ### Running test suite
 115
 116 Clippy uses UI tests. UI tests check that the output of the compiler is exactly as expected.
 117 Of course there's little sense in writing the output yourself or copying it around.
 118 Therefore you can simply run `tests/ui/update-all-references.sh` (after running
 119 `cargo test`) and check whether the output looks as you expect with `git diff`. Commit all
 120 `*.stderr` files, too.
 121
 122 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:
 123
 124 ```bash
 125 TESTNAME=ui/empty_line_after_outer_attr cargo test --test compile-test
 126 ```
 127
 128 ### Testing manually
 129
 130 Manually testing against an example file is useful if you have added some
 131 `println!`s and test suite output becomes unreadable.  To try clippy with your
 132 local modifications, run `cargo run --bin clippy-driver -- -L ./target/debug input.rs` from the
 133 working copy root. Your test file, here `input.rs`, needs to have clippy
 134 enabled as a plugin:
 135
 136 ```rust
 137 #![feature(plugin)]
 138 #![plugin(clippy)]
 139 ```
 140
 141 ## Contributions
 142
 143 Clippy welcomes contributions from everyone.
 144
 145 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
 146 be reviewed by a core contributor (someone with permission to land patches) and either landed in the
 147 main tree or given feedback for changes that would be required.
 148
 149 All code in this repository is under the [Mozilla Public License, 2.0](https://www.mozilla.org/MPL/2.0/)
 150
 151 ## Conduct
 152
 153 We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
 154
 155
 156 <!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->