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 Issues marked [E-medium](https://github.com/rust-lang-nursery/rust-clippy/labels/E-medium) are generally
  28 pretty easy too, though it's recommended you work on an E-easy issue first. They are mostly classified
  29 as `E-medium`, since they might be somewhat involved code wise, but not difficult per-se.
  30
  31 [Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is a nice primer
  32 to lint-writing, though it does get into advanced stuff. Most lints consist of an implementation of
  33 `LintPass` with one or more of its default methods overridden. See the existing lints for examples
  34 of this.
  35
  36 T-AST issues will generally need you to match against a predefined syntax structure. To figure out
  37 how this syntax structure is encoded in the AST, it is recommended to run `rustc -Z ast-json` on an
  38 example of the structure and compare with the
  39 [nodes in the AST docs](http://manishearth.github.io/rust-internals-docs/syntax/ast/). Usually
  40 the lint will end up to be a nested series of matches and ifs,
  41 [like so](https://github.com/rust-lang-nursery/rust-clippy/blob/de5ccdfab68a5e37689f3c950ed1532ba9d652a0/src/misc.rs#L34).
  42
  43 T-middle issues can be more involved and require verifying types. The
  44 [`ty`](http://manishearth.github.io/rust-internals-docs/rustc/ty) module contains a
  45 lot of methods that are useful, though one of the most useful would be `expr_ty` (gives the type of
  46 an AST expression). `match_def_path()` in Clippy's `utils` module can also be useful.
  47
  48 ### Writing code
  49
  50 Compiling clippy can take almost a minute or more depending on your machine.
  51 You can set the environment flag `CARGO_INCREMENTAL=1` to cut down that time to
  52 almost a third on average, depending on the influence your change has.
  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 /// ```rust
  65 /// Insert a short example if you have one.
  66 /// ```
  67 ```
  68
  69 ### Running test suite
  70
  71 Clippy uses UI tests. UI tests check that the output of the compiler is exactly as expected.
  72 Of course there's little sense in writing the output yourself or copying it around.
  73 Therefore you can simply run `tests/ui/update-all-references.sh` and check whether
  74 the output looks as you expect with `git diff`. Commit all `*.stderr` files, too.
  75
  76 ### Testing manually
  77
  78 Manually testing against an example file is useful if you have added some
  79 `println!`s and test suite output becomes unreadable.  To try clippy with your
  80 local modifications, run `cargo run --bin clippy-driver -- -L ./target/debug input.rs` from the
  81 working copy root. Your test file, here `input.rs`, needs to have clippy
  82 enabled as a plugin:
  83
  84 ```rust
  85 #![feature(plugin)]
  86 #![plugin(clippy)]
  87 ```
  88
  89 ## Contributions
  90
  91 Clippy welcomes contributions from everyone.
  92
  93 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
  94 be reviewed by a core contributor (someone with permission to land patches) and either landed in the
  95 main tree or given feedback for changes that would be required.
  96
  97 All code in this repository is under the [Mozilla Public License, 2.0](https://www.mozilla.org/MPL/2.0/)
  98
  99 ## Conduct
 100
 101 We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
 102
 103
 104 <!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->