CONTRIBUTING.md

   1 # Contributing to Clippy
   2
   3 Hello fellow Rustacean! Great to see your interest in compiler internals and lints!
   4
   5 **First**: if you're unsure or afraid of _anything_, just ask or submit the issue or pull request anyway. You won't be yelled at for giving it your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that.
   6
   7 Clippy welcomes contributions from everyone. There are many ways to contribute to Clippy and the following document explains how
   8 you can contribute and how to get started.
   9 If you have any questions about contributing or need help with anything, feel free to ask questions on issues or
  10 visit the `#clippy` IRC channel on `irc.mozilla.org` or meet us in `#wg-clippy` on [Discord](https://discord.gg/rust-lang).
  11
  12 All contributors are expected to follow the [Rust Code of Conduct](http://www.rust-lang.org/conduct.html).
  13
  14 * [Getting started](#getting-started)
  15   * [Finding something to fix/improve](#finding-something-to-fiximprove)
  16 * [Writing code](#writing-code)
  17 * [How Clippy works](#how-clippy-works)
  18 * [Fixing nightly build failures](#fixing-build-failures-caused-by-rust)
  19 * [Issue and PR Triage](#issue-and-pr-triage)
  20 * [Bors and Homu](#bors-and-homu)
  21 * [Contributions](#contributions)
  22
  23 ## Getting started
  24
  25 High level approach:
  26
  27 1. Find something to fix/improve
  28 2. Change code (likely some file in `clippy_lints/src/`)
  29 3. Run `cargo test` in the root directory and wiggle code until it passes
  30 4. Open a PR (also can be done between 2. and 3. if you run into problems)
  31
  32 ### Finding something to fix/improve
  33
  34 All issues on Clippy are mentored, if you want help with a bug just ask @Manishearth, @llogiq, @mcarton or @oli-obk.
  35
  36 Some issues are easier than others. The [`good first issue`](https://github.com/rust-lang/rust-clippy/labels/good%20first%20issue)
  37 label can be used to find the easy issues. If you want to work on an issue, please leave a comment
  38 so that we can assign it to you!
  39
  40 There are also some abandoned PRs, marked with
  41 [`S-inactive-closed`](https://github.com/rust-lang/rust-clippy/pulls?q=is%3Aclosed+label%3AS-inactive-closed).
  42 Pretty often these PRs are nearly completed and just need some extra steps
  43 (formatting, addressing review comments, ...) to be merged. If you want to
  44 complete such a PR, please leave a comment in the PR and open a new one based
  45 on it.
  46
  47 Issues marked [`T-AST`](https://github.com/rust-lang/rust-clippy/labels/T-AST) involve simple
  48 matching of the syntax tree structure, and are generally easier than
  49 [`T-middle`](https://github.com/rust-lang/rust-clippy/labels/T-middle) issues, which involve types
  50 and resolved paths.
  51
  52 [`T-AST`](https://github.com/rust-lang/rust-clippy/labels/T-AST) issues will generally need you to match against a predefined syntax structure. To figure out
  53 how this syntax structure is encoded in the AST, it is recommended to run `rustc -Z ast-json` on an
  54 example of the structure and compare with the
  55 [nodes in the AST docs](https://doc.rust-lang.org/nightly/nightly-rustc/syntax/ast). Usually
  56 the lint will end up to be a nested series of matches and ifs,
  57 [like so](https://github.com/rust-lang/rust-clippy/blob/de5ccdfab68a5e37689f3c950ed1532ba9d652a0/src/misc.rs#L34).
  58
  59 [`E-medium`](https://github.com/rust-lang/rust-clippy/labels/E-medium) issues are generally
  60 pretty easy too, though it's recommended you work on an E-easy issue first. They are mostly classified
  61 as `E-medium`, since they might be somewhat involved code wise, but not difficult per-se.
  62
  63 [`T-middle`](https://github.com/rust-lang/rust-clippy/labels/T-middle) issues can
  64 be more involved and require verifying types. The
  65 [`ty`](https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ty) module contains a
  66 lot of methods that are useful, though one of the most useful would be `expr_ty` (gives the type of
  67 an AST expression). `match_def_path()` in Clippy's `utils` module can also be useful.
  68
  69 ## Writing code
  70
  71 Have a look at the [docs for writing lints](doc/adding_lints.md) for more details. [Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is also a nice primer
  72 to lint-writing, though it does get into advanced stuff and may be a bit
  73 outdated.
  74
  75 If you want to add a new lint or change existing ones apart from bugfixing, it's
  76 also a good idea to give the [stability guarantees][rfc_stability] and
  77 [lint categories][rfc_lint_cats] sections of the [Clippy 1.0 RFC][clippy_rfc] a
  78 quick read.
  79
  80 ## How Clippy works
  81
  82 Clippy is a [rustc compiler plugin][compiler_plugin]. The main entry point is at [`src/lib.rs`][main_entry]. In there, the lint registration is delegated to the [`clippy_lints`][lint_crate] crate.
  83
  84 [`clippy_lints/src/lib.rs`][lint_crate_entry] imports all the different lint modules and registers them with the rustc plugin registry. For example, the [`else_if_without_else`][else_if_without_else] lint is registered like this:
  85
  86 ```rust
  87 // ./clippy_lints/src/lib.rs
  88
  89 // ...
  90 pub mod else_if_without_else;
  91 // ...
  92
  93 pub fn register_plugins(reg: &mut rustc_plugin::Registry) {
  94     // ...
  95     reg.register_early_lint_pass(box else_if_without_else::ElseIfWithoutElse);
  96     // ...
  97
  98     reg.register_lint_group("clippy::restriction", vec![
  99         // ...
 100         else_if_without_else::ELSE_IF_WITHOUT_ELSE,
 101         // ...
 102     ]);
 103 }
 104 ```
 105
 106 The [`rustc_plugin::PluginRegistry`][plugin_registry] provides two methods to register lints: [register_early_lint_pass][reg_early_lint_pass] and [register_late_lint_pass][reg_late_lint_pass].
 107 Both take an object that implements an [`EarlyLintPass`][early_lint_pass] or [`LateLintPass`][late_lint_pass] respectively. This is done in every single lint.
 108 It's worth noting that the majority of `clippy_lints/src/lib.rs` is autogenerated by `util/dev update_lints` and you don't have to add anything by hand. When you are writing your own lint, you can use that script to save you some time.
 109
 110 ```rust
 111 // ./clippy_lints/src/else_if_without_else.rs
 112
 113 use rustc::lint::{EarlyLintPass, LintArray, LintPass};
 114
 115 // ...
 116
 117 pub struct ElseIfWithoutElse;
 118
 119 // ...
 120
 121 impl EarlyLintPass for ElseIfWithoutElse {
 122     // ... the functions needed, to make the lint work
 123 }
 124 ```
 125
 126 The difference between `EarlyLintPass` and `LateLintPass` is that the methods of the `EarlyLintPass` trait only provide AST information. The methods of the `LateLintPass` trait are executed after type checking and contain type information via the `LateContext` parameter.
 127
 128 That's why the `else_if_without_else` example uses the `register_early_lint_pass` function. Because the [actual lint logic][else_if_without_else] does not depend on any type information.
 129
 130 ## Fixing build failures caused by Rust
 131
 132 Clippy will sometimes fail to build from source because building it depends on unstable internal Rust features. Most of the times we have to adapt to the changes and only very rarely there's an actual bug in Rust. Fixing build failures caused by Rust updates, can be a good way to learn about Rust internals.
 133
 134 In order to find out why Clippy does not work properly with a new Rust commit, you can use the [rust-toolstate commit history][toolstate_commit_history].
 135 You will then have to look for the last commit that contains `test-pass -> build-fail` or `test-pass` -> `test-fail` for the `clippy-driver` component. [Here][toolstate_commit] is an example.
 136
 137 The commit message contains a link to the PR. The PRs are usually small enough to discover the breaking API change and if they are bigger, they likely include some discussion that may help you to fix Clippy.
 138
 139 To check if Clippy is available for a specific target platform, you can check
 140 the [rustup component history][rustup_component_history].
 141
 142 If you decide to make Clippy work again with a Rust commit that breaks it,
 143 you probably want to install the latest Rust from master locally and run Clippy
 144 using that version of Rust.
 145
 146 You can use [rustup-toolchain-install-master][rtim] to do that:
 147
 148 ```
 149 cargo install rustup-toolchain-install-master
 150 rustup-toolchain-install-master -n master --force
 151 rustup override set master
 152 cargo test
 153 ```
 154
 155 ## Issue and PR triage
 156
 157 Clippy is following the [Rust triage procedure][triage] for issues and pull
 158 requests.
 159
 160 However, we are a smaller project with all contributors being volunteers
 161 currently. Between writing new lints, fixing issues, reviewing pull requests and
 162 responding to issues there may not always be enough time to stay on top of it
 163 all.
 164
 165 Our highest priority is fixing [crashes][l-crash] and [bugs][l-bug]. We don't
 166 want Clippy to crash on your code and we want it to be as reliable as the
 167 suggestions from Rust compiler errors.
 168
 169 ## Bors and Homu
 170
 171 We use a bot powered by [Homu][homu] to help automate testing and landing of pull
 172 requests in Clippy. The bot's username is @bors.
 173
 174 You can find the Clippy bors queue [here][homu_queue].
 175
 176 If you have @bors permissions, you can find an overview of the available
 177 commands [here][homu_instructions].
 178
 179
 180 ## Contributions
 181
 182 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
 183 be reviewed by a core contributor (someone with permission to land patches) and either landed in the
 184 main tree or given feedback for changes that would be required.
 185
 186 All code in this repository is under the [Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0>)
 187 or the [MIT](http://opensource.org/licenses/MIT) license.
 188
 189 <!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->
 190
 191 [main_entry]: https://github.com/rust-lang/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/src/lib.rs#L14
 192 [lint_crate]: https://github.com/rust-lang/rust-clippy/tree/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src
 193 [lint_crate_entry]: https://github.com/rust-lang/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src/lib.rs
 194 [else_if_without_else]: https://github.com/rust-lang/rust-clippy/blob/c5b39a5917ffc0f1349b6e414fa3b874fdcf8429/clippy_lints/src/else_if_without_else.rs
 195 [compiler_plugin]: https://doc.rust-lang.org/unstable-book/language-features/plugin.html#lint-plugins
 196 [plugin_registry]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html
 197 [reg_early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html#method.register_early_lint_pass
 198 [reg_late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_plugin/registry/struct.Registry.html#method.register_late_lint_pass
 199 [early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.EarlyLintPass.html
 200 [late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/lint/trait.LateLintPass.html
 201 [toolstate_commit_history]: https://github.com/rust-lang-nursery/rust-toolstate/commits/master
 202 [toolstate_commit]: https://github.com/rust-lang-nursery/rust-toolstate/commit/6ce0459f6bfa7c528ae1886492a3e0b5ef0ee547
 203 [rtim]: https://github.com/kennytm/rustup-toolchain-install-master
 204 [rustup_component_history]: https://mexus.github.io/rustup-components-history
 205 [clippy_rfc]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md
 206 [rfc_stability]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees
 207 [rfc_lint_cats]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories
 208 [triage]: https://forge.rust-lang.org/triage-procedure.html
 209 [l-crash]: https://github.com/rust-lang/rust-clippy/labels/L-crash%20%3Aboom%3A
 210 [l-bug]: https://github.com/rust-lang/rust-clippy/labels/L-bug%20%3Abeetle%3A
 211 [homu]: https://github.com/servo/homu
 212 [homu_instructions]: https://buildbot2.rust-lang.org/homu/
 213 [homu_queue]: https://buildbot2.rust-lang.org/homu/queue/clippy