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 All issues on Clippy are mentored, if you want help with a bug just ask @Manishearth or @llogiq.
   8
   9 Some issues are easier than others. The [E-easy](https://github.com/Manishearth/rust-clippy/labels/E-easy)
  10 label can be used to find the easy issues. If you want to work on an issue, please leave a comment
  11 so that we can assign it to you!
  12
  13 Issues marked [T-AST](https://github.com/Manishearth/rust-clippy/labels/T-AST) involve simple
  14 matching of the syntax tree structure, and are generally easier than
  15 [T-middle](https://github.com/Manishearth/rust-clippy/labels/T-middle) issues, which involve types
  16 and resolved paths.
  17
  18 Issues marked [E-medium](https://github.com/Manishearth/rust-clippy/labels/E-medium) are generally
  19 pretty easy too, though it's recommended you work on an E-easy issue first.
  20
  21 [Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is a nice primer
  22 to lint-writing, though it does get into advanced stuff. Most lints consist of an implementation of
  23 `LintPass` with one or more of its default methods overridden. See the existing lints for examples
  24 of this.
  25
  26 T-AST issues will generally need you to match against a predefined syntax structure. To figure out
  27 how this syntax structure is encoded in the AST, it is recommended to run `rustc -Z ast-json` on an
  28 example of the structure and compare with the
  29 [nodes in the AST docs](http://manishearth.github.io/rust-internals-docs/syntax/ast/). Usually
  30 the lint will end up to be a nested series of matches and ifs,
  31 [like so](https://github.com/Manishearth/rust-clippy/blob/de5ccdfab68a5e37689f3c950ed1532ba9d652a0/src/misc.rs#L34).
  32
  33 T-middle issues can be more involved and require verifying types. The
  34 [`ty`](http://manishearth.github.io/rust-internals-docs/rustc/ty) module contains a
  35 lot of methods that are useful, though one of the most useful would be `expr_ty` (gives the type of
  36 an AST expression). `match_def_path()` in Clippy's `utils` module can also be useful.
  37
  38 Compiling clippy can take almost a minute or more depending on your machine.
  39 You can set the environment flag `CARGO_INCREMENTAL=1` to cut down that time to
  40 almost a third on average, depending on the influence your change has.
  41
  42 Clippy uses its own version of UI tests. Run `cargo test examples` to run only the ui tests.
  43 This will update all the `*.stderr` files in `clippy_tests/examples`. You need to check
  44 the stderr files whether they look as you expected them and commit them together with your
  45 changes.
  46 When you want to test a new lint, just create a new file in `clippy_tests/examples` and
  47 rerun `cargo test examples`.
  48
  49 You can check just one example by running `cargo run --example example_name` inside the
  50 `clippy_tests` directory.
  51
  52 Also please document your lint with a doc comment akin to the following:
  53 ```rust
  54 /// **What it does:** Checks for ... (describe what the lint matches).
  55 ///
  56 /// **Why is this bad?** Supply the reason for linting the code.
  57 ///
  58 /// **Known problems:** None. (Or describe where it could go wrong.)
  59 ///
  60 /// **Example:**
  61 /// ```rust
  62 /// Insert a short example if you have one.
  63 /// ```
  64 ```
  65
  66 Our `util/update_wiki.py` script can then add your lint docs to the wiki.
  67
  68 ## Contributions
  69
  70 Clippy welcomes contributions from everyone.
  71
  72 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
  73 be reviewed by a core contributor (someone with permission to land patches) and either landed in the
  74 main tree or given feedback for changes that would be required.
  75
  76 All code in this repository is under the [Mozilla Public License, 2.0](https://www.mozilla.org/MPL/2.0/)
  77
  78 ## Conduct
  79
  80 We follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
  81
  82
  83 <!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->