<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/clippy/CONTRIBUTING.md - fork/rust @ master</title>
<meta name="description" content="src/tools/clippy/CONTRIBUTING.md in fork/rust at master.">
<meta property="og:title" content="src/tools/clippy/CONTRIBUTING.md - fork/rust @ master">
<meta property="og:description" content="src/tools/clippy/CONTRIBUTING.md in fork/rust at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="3bcad65fbf67b6edf87c949531fbc13435882e6b">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">bors</span><span class="commit-message" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">Auto merge of #103046 - JanBeh:PR_clarify_cmp_terminology, r=workingjubilee</span><span class="snapshot-sha sha" data-commit="3bcad65fbf67b6edf87c949531fbc13435882e6b">3bcad65fbf6</span><time datetime="2023-10-05T15:24:54+00:00" title="2023-10-05 15:24:54 +0000">2023-10-05</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/rust/ref/master/">master</a><strong>tags</strong><a href="/fork/rust/ref/1.39.0/">1.39.0</a><a href="/fork/rust/ref/1.40.0/">1.40.0</a><a href="/fork/rust/ref/1.41.0/">1.41.0</a><a href="/fork/rust/ref/1.41.1/">1.41.1</a><a href="/fork/rust/ref/1.42.0/">1.42.0</a><a href="/fork/rust/ref/1.43.0/">1.43.0</a><a href="/fork/rust/ref/1.43.1/">1.43.1</a><a href="/fork/rust/ref/1.44.0/">1.44.0</a><a class="all" href="/fork/rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rust/">rust</a> / <a href="/fork/rust/ref/master/tree/src/">src</a> / <a href="/fork/rust/ref/master/tree/src/tools/">tools</a> / <a href="/fork/rust/ref/master/tree/src/tools/clippy/">clippy</a> / <span class="cur">CONTRIBUTING.md</span></nav>
<span class="view-stats"><span>13.1 KiB</span><span>286 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/04af1b98b556e6bdcef43e6e42e53e3f472b588c/src/tools/clippy/CONTRIBUTING.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Contributing to Clippy</h1>
<p>Hello fellow Rustacean! Great to see your interest in compiler internals and lints!</p>
<p><strong>First</strong>: if you're unsure or afraid of <em>anything</em>, 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.</p>
<p>Clippy welcomes contributions from everyone. There are many ways to contribute to Clippy and the following document
explains how you can contribute and how to get started.  If you have any questions about contributing or need help with
anything, feel free to ask questions on issues or visit the <code>#clippy</code> on <a href="https://rust-lang.zulipchat.com/#narrow/stream/clippy">Zulip</a>.</p>
<p>All contributors are expected to follow the <a href="https://www.rust-lang.org/policies/code-of-conduct">Rust Code of Conduct</a>.</p>
<ul>
<li><a href="#contributing-to-clippy">Contributing to Clippy</a>
<ul>
<li><a href="#the-clippy-book">The Clippy book</a></li>
<li><a href="#high-level-approach">High level approach</a></li>
<li><a href="#finding-something-to-fiximprove">Finding something to fix/improve</a></li>
<li><a href="#getting-code-completion-for-rustc-internals-to-work">Getting code-completion for rustc internals to work</a>
<ul>
<li><a href="#intellij-rust">IntelliJ Rust</a></li>
<li><a href="#rust-analyzer">Rust Analyzer</a></li>
</ul>
</li>
<li><a href="#how-clippy-works">How Clippy works</a></li>
<li><a href="#issue-and-pr-triage">Issue and PR triage</a></li>
<li><a href="#bors-and-homu">Bors and Homu</a></li>
<li><a href="#contributions">Contributions</a></li>
<li><a href="#license">License</a></li>
</ul>
</li>
</ul>
<h2>The Clippy book</h2>
<p>If you're new to Clippy and don't know where to start, the <a href="https://doc.rust-lang.org/nightly/clippy/index.html">Clippy book</a> includes
a <a href="https://doc.rust-lang.org/nightly/clippy/development/index.html">developer guide</a> and is a good place to start your journey.</p>
<h2>High level approach</h2>
<ol>
<li>Find something to fix/improve</li>
<li>Change code (likely some file in <code>clippy_lints/src/</code>)</li>
<li>Follow the instructions in the <a href="/fork/rust/ref/master/blob/src/tools/clippy/book/src/development/basics.md">Basics docs</a>
to get set up</li>
<li>Run <code>cargo test</code> in the root directory and wiggle code until it passes</li>
<li>Open a PR (also can be done after 2. if you run into problems)</li>
</ol>
<h2>Finding something to fix/improve</h2>
<p>All issues on Clippy are mentored, if you want help simply ask someone from the
Clippy team directly by mentioning them in the issue or over on <a href="https://rust-lang.zulipchat.com/#narrow/stream/clippy">Zulip</a>. All
currently active team members can be found
<a href="https://github.com/rust-lang/rust-clippy/blob/master/triagebot.toml#L18">here</a></p>
<p>Some issues are easier than others. The <a href="https://github.com/rust-lang/rust-clippy/labels/good-first-issue"><code>good-first-issue</code></a> label can be used to find the easy
issues. You can use <code>@rustbot claim</code> to assign the issue to yourself.</p>
<p>There are also some abandoned PRs, marked with <a href="https://github.com/rust-lang/rust-clippy/pulls?q=is%3Aclosed+label%3AS-inactive-closed"><code>S-inactive-closed</code></a>.
Pretty often these PRs are nearly completed and just need some extra steps
(formatting, addressing review comments, ...) to be merged. If you want to
complete such a PR, please leave a comment in the PR and open a new one based
on it.</p>
<p>Issues marked <a href="https://github.com/rust-lang/rust-clippy/labels/T-AST"><code>T-AST</code></a> involve simple matching of the syntax tree structure,
and are generally easier than <a href="https://github.com/rust-lang/rust-clippy/labels/T-middle"><code>T-middle</code></a> issues, which involve types
and resolved paths.</p>
<p><a href="https://github.com/rust-lang/rust-clippy/labels/T-AST"><code>T-AST</code></a> issues will generally need you to match against a predefined syntax structure.
To figure out how this syntax structure is encoded in the AST, it is recommended to run
<code>rustc -Z unpretty=ast-tree</code> on an example of the structure and compare with the <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_ast/ast/">nodes in the AST docs</a>.
Usually the lint will end up to be a nested series of matches and ifs, <a href="https://github.com/rust-lang/rust-clippy/blob/5e4f0922911536f80d9591180fa604229ac13939/clippy_lints/src/mem_forget.rs#L31-L45">like so</a>.
But we can make it nest-less by using <a href="https://github.com/rust-lang/rust/pull/94927">let chains</a>, <a href="https://github.com/rust-lang/rust-clippy/blob/5e4f0922911536f80d9591180fa604229ac13939/clippy_lints/src/bit_mask.rs#L133-L159">like this</a>.</p>
<p><a href="https://github.com/rust-lang/rust-clippy/labels/E-medium"><code>E-medium</code></a> issues are generally pretty easy too, though it's recommended you work on an <a href="https://github.com/rust-lang/rust-clippy/labels/good-first-issue"><code>good-first-issue</code></a>
first. Sometimes they are only somewhat involved code wise, but not difficult per-se.
Note that <a href="https://github.com/rust-lang/rust-clippy/labels/E-medium"><code>E-medium</code></a> issues may require some knowledge of Clippy internals or some
debugging to find the actual problem behind the issue.</p>
<p><a href="https://github.com/rust-lang/rust-clippy/labels/T-middle"><code>T-middle</code></a> issues can be more involved and require verifying types. The <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/ty"><code>ty</code></a> module contains a
lot of methods that are useful, though one of the most useful would be <code>expr_ty</code> (gives the type of
an AST expression). <code>match_def_path()</code> in Clippy's <code>utils</code> module can also be useful.</p>
<h2>Getting code-completion for rustc internals to work</h2>
<h3>IntelliJ Rust</h3>
<p>Unfortunately, <a href="https://intellij-rust.github.io/"><code>IntelliJ Rust</code></a> does not (yet?) understand how Clippy uses compiler-internals
using <code>extern crate</code> and it also needs to be able to read the source files of the rustc-compiler which are not
available via a <code>rustup</code> component at the time of writing.
To work around this, you need to have a copy of the <a href="https://github.com/rust-lang/rust/">rustc-repo</a> available which can be obtained via
<code>git clone https://github.com/rust-lang/rust/</code>.
Then you can run a <code>cargo dev</code> command to automatically make Clippy use the rustc-repo via path-dependencies
which <code>IntelliJ Rust</code> will be able to understand.
Run <code>cargo dev setup intellij --repo-path &lt;repo-path&gt;</code> where <code>&lt;repo-path&gt;</code> is a path to the rustc repo
you just cloned.
The command will add path-dependencies pointing towards rustc-crates inside the rustc repo to
Clippy's <code>Cargo.toml</code>s and should allow <code>IntelliJ Rust</code> to understand most of the types that Clippy uses.
Just make sure to remove the dependencies again before finally making a pull request!</p>
<h3>Rust Analyzer</h3>
<p>For <a href="https://rust-analyzer.github.io/"><code>rust-analyzer</code></a> to work correctly make sure that in the <code>rust-analyzer</code> configuration you set</p>
<pre class="language-json">{ <a-s>&quot;rust-analyzer.rustc.source&quot;</a-s>: <a-s>&quot;discover&quot;</a-s> }</pre>
<p>You should be able to see information on things like <code>Expr</code> or <code>EarlyContext</code> now if you hover them, also
a lot more type hints.</p>
<p>To have <code>rust-analyzer</code> also work in the <code>clippy_dev</code> and <code>lintcheck</code> crates, add the following configuration</p>
<pre class="language-json">{
    <a-s>&quot;rust-analyzer.linkedProjects&quot;</a-s>: [
        <a-s>&quot;./Cargo.toml&quot;</a-s>,
        <a-s>&quot;clippy_dev/Cargo.toml&quot;</a-s>,
        <a-s>&quot;lintcheck/Cargo.toml&quot;</a-s>,<a-n>
    ]
}</a-n></pre>
<h2>How Clippy works</h2>
<p><a href="https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/lib.rs"><code>clippy_lints/src/lib.rs</code></a> imports all the different lint modules and registers in the <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html"><code>LintStore</code></a>.
For example, the <a href="https://github.com/rust-lang/rust-clippy/blob/4253aa7137cb7378acc96133c787e49a345c2b3c/clippy_lints/src/else_if_without_else.rs"><code>else_if_without_else</code></a> lint is registered like this:</p>
<pre class="language-rust"><a-c>// ./clippy_lints/src/lib.rs</a-c>

<a-c>// ...</a-c>
<a-k>pub</a-k> <a-k>mod</a-k> else_if_without_else<a-p>;</a-p>
<a-c>// ...</a-c>

<a-k>pub</a-k> <a-k>fn</a-k> <a-f>register_plugins</a-f><a-p>(</a-p><a-v>store</a-v><a-p>:</a-p> <a-o>&amp;</a-o><a-k>mut</a-k> rustc_lint<a-p>::</a-p><a-t>LintStore</a-t><a-p>,</a-p> <a-v>sess</a-v><a-p>:</a-p> <a-o>&amp;</a-o><a-t>Session</a-t><a-p>,</a-p> <a-v>conf</a-v><a-p>:</a-p> <a-o>&amp;</a-o><a-t>Conf</a-t><a-p>)</a-p> <a-p>{</a-p>
    <a-c>// ...</a-c>
    store<a-p>.</a-p><a-f>register_early_pass</a-f><a-p>(</a-p>|| <a-t>Box</a-t><a-p>::</a-p><a-f>new</a-f><a-p>(</a-p>else_if_without_else<a-p>::</a-p><a-cr>ElseIfWithoutElse</a-cr><a-p>));</a-p>
    <a-c>// ...</a-c>

    store<a-p>.</a-p><a-f>register_group</a-f><a-p>(</a-p><a-co>true</a-co><a-p>,</a-p> <a-s>&quot;clippy::restriction&quot;</a-s><a-p>,</a-p> <a-f>Some</a-f><a-p>(</a-p><a-s>&quot;clippy_restriction&quot;</a-s><a-p>),</a-p> <a-m>vec!</a-m><a-p>[</a-p>
        <a-c>// ...</a-c>
        <a-t>LintId</a-t><a-p>::</a-p><a-f>of</a-f><a-p>(</a-p><a-o>&amp;</a-o>else_if_without_else<a-p>::</a-p><a-cr>ELSE_IF_WITHOUT_ELSE</a-cr><a-p>),</a-p>
        <a-c>// ...</a-c>
    <a-p>]);</a-p>
<a-p>}</a-p></pre>
<p>The <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html"><code>rustc_lint::LintStore</code></a> provides two methods to register lints:
<a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_early_pass">register_early_pass</a> and <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_late_pass">register_late_pass</a>. Both take an object
that implements an <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.EarlyLintPass.html"><code>EarlyLintPass</code></a> or <a href="https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.LateLintPass.html"><code>LateLintPass</code></a> respectively. This is done in
every single lint. It's worth noting that the majority of <code>clippy_lints/src/lib.rs</code> is autogenerated by <code>cargo dev update_lints</code>. When you are writing your own lint, you can use that script to save you some time.</p>
<pre class="language-rust"><a-c>// ./clippy_lints/src/else_if_without_else.rs</a-c>

<a-k>use</a-k> rustc_lint<a-p>::{</a-p><a-cr>EarlyLintPass</a-cr><a-p>,</a-p> <a-cr>EarlyContext</a-cr><a-p>};</a-p>

<a-c>// ...</a-c>

<a-k>pub</a-k> <a-k>struct</a-k> <a-t>ElseIfWithoutElse</a-t><a-p>;</a-p>

<a-c>// ...</a-c>

<a-k>impl</a-k> <a-t>EarlyLintPass</a-t> <a-k>for</a-k> <a-t>ElseIfWithoutElse</a-t> <a-p>{</a-p>
    <a-c>// ... the functions needed, to make the lint work</a-c>
<a-p>}</a-p></pre>
<p>The difference between <code>EarlyLintPass</code> and <code>LateLintPass</code> is that the methods of the <code>EarlyLintPass</code> trait only provide
AST information. The methods of the <code>LateLintPass</code> trait are executed after type checking and contain type information
via the <code>LateContext</code> parameter.</p>
<p>That's why the <code>else_if_without_else</code> example uses the <code>register_early_pass</code> function. Because the
<a href="https://github.com/rust-lang/rust-clippy/blob/4253aa7137cb7378acc96133c787e49a345c2b3c/clippy_lints/src/else_if_without_else.rs">actual lint logic</a> does not depend on any type information.</p>
<h2>Issue and PR triage</h2>
<p>Clippy is following the <a href="https://forge.rust-lang.org/release/triage-procedure.html">Rust triage procedure</a> for issues and pull
requests.</p>
<p>However, we are a smaller project with all contributors being volunteers
currently. Between writing new lints, fixing issues, reviewing pull requests and
responding to issues there may not always be enough time to stay on top of it
all.</p>
<p>Our highest priority is fixing <a href="https://github.com/rust-lang/rust-clippy/labels/L-crash">crashes</a> and <a href="https://github.com/rust-lang/rust-clippy/labels/L-bug">bugs</a>, for example
an ICE in a popular crate that many other crates depend on. We don't
want Clippy to crash on your code and we want it to be as reliable as the
suggestions from Rust compiler errors.</p>
<p>We have prioritization labels and a sync-blocker label, which are described below.</p>
<ul>
<li><a href="https://github.com/rust-lang/rust-clippy/labels/P-low">P-low</a>: Requires attention (fix/response/evaluation) by a team member but isn't urgent.</li>
<li><a href="https://github.com/rust-lang/rust-clippy/labels/P-medium">P-medium</a>: Should be addressed by a team member until the next sync.</li>
<li><a href="https://github.com/rust-lang/rust-clippy/labels/P-high">P-high</a>: Should be immediately addressed and will require an out-of-cycle sync or a backport.</li>
<li><a href="https://github.com/rust-lang/rust-clippy/labels/L-sync-blocker">L-sync-blocker</a>: An issue that "blocks" a sync.
Or rather: before the sync this should be addressed,
e.g. by removing a lint again, so it doesn't hit beta/stable.</li>
</ul>
<h2>Bors and Homu</h2>
<p>We use a bot powered by <a href="https://github.com/rust-lang/homu">Homu</a> to help automate testing and landing of pull
requests in Clippy. The bot's username is @bors.</p>
<p>You can find the Clippy bors queue <a href="https://bors.rust-lang.org/queue/clippy">here</a>.</p>
<p>If you have @bors permissions, you can find an overview of the available
commands <a href="https://bors.rust-lang.org/">here</a>.</p>
<h2>Contributions</h2>
<p>Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
be reviewed by a core contributor (someone with permission to land patches) and either landed in the
main tree or given feedback for changes that would be required.</p>
<p>All PRs should include a <code>changelog</code> entry with a short comment explaining the change. The rule of thumb is basically,
"what do you believe is important from an outsider's perspective?" Often, PRs are only related to a single property of a
lint, and then it's good to mention that one. Otherwise, it's better to include too much detail than too little.</p>
<p>Clippy's <a href="/fork/rust/ref/master/blob/src/tools/clippy/CHANGELOG.md">changelog</a> is created from these comments. Every release, someone gets all commits from bors with a
<code>changelog: XYZ</code> entry and combines them into the changelog. This is a manual process.</p>
<p>Examples:</p>
<ul>
<li>New lint<pre>changelog: new lint: [`missing_trait_methods`]
</pre>
</li>
<li>False positive fix<pre>changelog: Fix [`unused_peekable`] false positive when peeked in a closure or called as `f(&amp;mut peekable)`
</pre>
</li>
<li>Purely internal change<pre>changelog: none
</pre>
</li>
</ul>
<p>Note this it is fine for a PR to include multiple <code>changelog</code> entries, e.g.:</p>
<pre>changelog: Something 1
changelog: Something 2
changelog: Something 3
</pre>
<h2>License</h2>
<p>All code in this repository is under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache-2.0</a> or the <a href="https://opensource.org/licenses/MIT">MIT</a> license.</p>
&lt;!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md --&gt;
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/clippy/CONTRIBUTING.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># Contributing to Clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">Hello fellow Rustacean! Great to see your interest in compiler internals and lints!</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">**First**: if you're unsure or afraid of _anything_, just ask or submit the issue or pull request anyway. You won't be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">yelled at for giving it your best effort. The worst that can happen is that you'll be politely asked to change</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">Clippy welcomes contributions from everyone. There are many ways to contribute to Clippy and the following document</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">explains how you can contribute and how to get started.  If you have any questions about contributing or need help with</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">anything, feel free to ask questions on issues or visit the `#clippy` on [Zulip].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">All contributors are expected to follow the [Rust Code of Conduct].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">- [Contributing to Clippy](#contributing-to-clippy)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">  - [The Clippy book](#the-clippy-book)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">  - [High level approach](#high-level-approach)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">  - [Finding something to fix/improve](#finding-something-to-fiximprove)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">  - [Getting code-completion for rustc internals to work](#getting-code-completion-for-rustc-internals-to-work)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">    - [IntelliJ Rust](#intellij-rust)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">    - [Rust Analyzer](#rust-analyzer)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">  - [How Clippy works](#how-clippy-works)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">  - [Issue and PR triage](#issue-and-pr-triage)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">  - [Bors and Homu](#bors-and-homu)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">  - [Contributions](#contributions)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">  - [License](#license)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">[Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">[Rust Code of Conduct]: https://www.rust-lang.org/policies/code-of-conduct</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">## The Clippy book</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">If you're new to Clippy and don't know where to start, the [Clippy book] includes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">a [developer guide] and is a good place to start your journey.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">[Clippy book]: https://doc.rust-lang.org/nightly/clippy/index.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">[developer guide]: https://doc.rust-lang.org/nightly/clippy/development/index.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">## High level approach</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">1. Find something to fix/improve</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">2. Change code (likely some file in `clippy_lints/src/`)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text">3. Follow the instructions in the [Basics docs](book/src/development/basics.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">   to get set up</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text">4. Run `cargo test` in the root directory and wiggle code until it passes</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text">5. Open a PR (also can be done after 2. if you run into problems)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text">## Finding something to fix/improve</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text">All issues on Clippy are mentored, if you want help simply ask someone from the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text">Clippy team directly by mentioning them in the issue or over on [Zulip]. All</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text">currently active team members can be found</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text">[here](https://github.com/rust-lang/rust-clippy/blob/master/triagebot.toml#L18)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text">Some issues are easier than others. The [`good-first-issue`] label can be used to find the easy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text">issues. You can use `@rustbot claim` to assign the issue to yourself.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text">There are also some abandoned PRs, marked with [`S-inactive-closed`].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text">Pretty often these PRs are nearly completed and just need some extra steps</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text">(formatting, addressing review comments, ...) to be merged. If you want to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text">complete such a PR, please leave a comment in the PR and open a new one based</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text">on it.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text">Issues marked [`T-AST`] involve simple matching of the syntax tree structure,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text">and are generally easier than [`T-middle`] issues, which involve types</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text">and resolved paths.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text">[`T-AST`] issues will generally need you to match against a predefined syntax structure.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text">To figure out how this syntax structure is encoded in the AST, it is recommended to run</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text">`rustc -Z unpretty=ast-tree` on an example of the structure and compare with the [nodes in the AST docs].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text">Usually the lint will end up to be a nested series of matches and ifs, [like so][deep-nesting].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text">But we can make it nest-less by using [let chains], [like this][nest-less].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text">[`E-medium`] issues are generally pretty easy too, though it's recommended you work on an [`good-first-issue`]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text">first. Sometimes they are only somewhat involved code wise, but not difficult per-se.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text">Note that [`E-medium`] issues may require some knowledge of Clippy internals or some</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text">debugging to find the actual problem behind the issue.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text">[`T-middle`] issues can be more involved and require verifying types. The [`ty`] module contains a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text">lot of methods that are useful, though one of the most useful would be `expr_ty` (gives the type of</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text">an AST expression). `match_def_path()` in Clippy's `utils` module can also be useful.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text">[`good-first-issue`]: https://github.com/rust-lang/rust-clippy/labels/good-first-issue</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text">[`S-inactive-closed`]: https://github.com/rust-lang/rust-clippy/pulls?q=is%3Aclosed+label%3AS-inactive-closed</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text">[`T-AST`]: https://github.com/rust-lang/rust-clippy/labels/T-AST</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text">[`T-middle`]: https://github.com/rust-lang/rust-clippy/labels/T-middle</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text">[`E-medium`]: https://github.com/rust-lang/rust-clippy/labels/E-medium</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text">[`ty`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/ty</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text">[nodes in the AST docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_ast/ast/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text">[deep-nesting]: https://github.com/rust-lang/rust-clippy/blob/5e4f0922911536f80d9591180fa604229ac13939/clippy_lints/src/mem_forget.rs#L31-L45</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text">[let chains]: https://github.com/rust-lang/rust/pull/94927</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text">[nest-less]: https://github.com/rust-lang/rust-clippy/blob/5e4f0922911536f80d9591180fa604229ac13939/clippy_lints/src/bit_mask.rs#L133-L159</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text">## Getting code-completion for rustc internals to work</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text">### IntelliJ Rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text">Unfortunately, [`IntelliJ Rust`][IntelliJ_rust_homepage] does not (yet?) understand how Clippy uses compiler-internals</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text">using `extern crate` and it also needs to be able to read the source files of the rustc-compiler which are not</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text">available via a `rustup` component at the time of writing.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text">To work around this, you need to have a copy of the [rustc-repo][rustc_repo] available which can be obtained via</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text">`git clone https://github.com/rust-lang/rust/`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text">Then you can run a `cargo dev` command to automatically make Clippy use the rustc-repo via path-dependencies</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text">which `IntelliJ Rust` will be able to understand.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text">Run `cargo dev setup intellij --repo-path &lt;repo-path&gt;` where `&lt;repo-path&gt;` is a path to the rustc repo</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text">you just cloned.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text">The command will add path-dependencies pointing towards rustc-crates inside the rustc repo to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text">Clippy's `Cargo.toml`s and should allow `IntelliJ Rust` to understand most of the types that Clippy uses.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text">Just make sure to remove the dependencies again before finally making a pull request!</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text">[rustc_repo]: https://github.com/rust-lang/rust/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text">[IntelliJ_rust_homepage]: https://intellij-rust.github.io/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text">### Rust Analyzer</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text">For [`rust-analyzer`][ra_homepage] to work correctly make sure that in the `rust-analyzer` configuration you set</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text">```json</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text">{ &quot;rust-analyzer.rustc.source&quot;: &quot;discover&quot; }</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text">You should be able to see information on things like `Expr` or `EarlyContext` now if you hover them, also</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text">a lot more type hints.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text">To have `rust-analyzer` also work in the `clippy_dev` and `lintcheck` crates, add the following configuration</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text">```json</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text">{</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text">    &quot;rust-analyzer.linkedProjects&quot;: [</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">        &quot;./Cargo.toml&quot;,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text">        &quot;clippy_dev/Cargo.toml&quot;,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text">        &quot;lintcheck/Cargo.toml&quot;,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text">    ]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text">[ra_homepage]: https://rust-analyzer.github.io/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text">## How Clippy works</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text">[`clippy_lints/src/lib.rs`][lint_crate_entry] imports all the different lint modules and registers in the [`LintStore`].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text">For example, the [`else_if_without_else`][else_if_without_else] lint is registered like this:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text">```rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text">// ./clippy_lints/src/lib.rs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text">// ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text">pub mod else_if_without_else;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text">// ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text">pub fn register_plugins(store: &amp;mut rustc_lint::LintStore, sess: &amp;Session, conf: &amp;Conf) {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text">    // ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text">    store.register_early_pass(|| Box::new(else_if_without_else::ElseIfWithoutElse));</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text">    // ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text">    store.register_group(true, &quot;clippy::restriction&quot;, Some(&quot;clippy_restriction&quot;), vec![</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text">        // ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text">        LintId::of(&amp;else_if_without_else::ELSE_IF_WITHOUT_ELSE),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text">        // ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text">    ]);</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text">The [`rustc_lint::LintStore`][`LintStore`] provides two methods to register lints:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text">[register_early_pass][reg_early_pass] and [register_late_pass][reg_late_pass]. Both take an object</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text">that implements an [`EarlyLintPass`][early_lint_pass] or [`LateLintPass`][late_lint_pass] respectively. This is done in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text">every single lint. It's worth noting that the majority of `clippy_lints/src/lib.rs` is autogenerated by `cargo dev</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text">update_lints`. When you are writing your own lint, you can use that script to save you some time.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text">```rust</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text">// ./clippy_lints/src/else_if_without_else.rs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text">use rustc_lint::{EarlyLintPass, EarlyContext};</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text">// ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text">pub struct ElseIfWithoutElse;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text">// ...</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text">impl EarlyLintPass for ElseIfWithoutElse {</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text">    // ... the functions needed, to make the lint work</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text">}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text">The difference between `EarlyLintPass` and `LateLintPass` is that the methods of the `EarlyLintPass` trait only provide</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text">AST information. The methods of the `LateLintPass` trait are executed after type checking and contain type information</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text">via the `LateContext` parameter.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text">That's why the `else_if_without_else` example uses the `register_early_pass` function. Because the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text">[actual lint logic][else_if_without_else] does not depend on any type information.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text">[lint_crate_entry]: https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/lib.rs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text">[else_if_without_else]: https://github.com/rust-lang/rust-clippy/blob/4253aa7137cb7378acc96133c787e49a345c2b3c/clippy_lints/src/else_if_without_else.rs</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text">[`LintStore`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text">[reg_early_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_early_pass</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text">[reg_late_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_late_pass</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text">[early_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.EarlyLintPass.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text">[late_lint_pass]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.LateLintPass.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text">## Issue and PR triage</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text">Clippy is following the [Rust triage procedure][triage] for issues and pull</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text">requests.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text">However, we are a smaller project with all contributors being volunteers</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text">currently. Between writing new lints, fixing issues, reviewing pull requests and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text">responding to issues there may not always be enough time to stay on top of it</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text">all.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text">Our highest priority is fixing [crashes][l-crash] and [bugs][l-bug], for example</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text">an ICE in a popular crate that many other crates depend on. We don't</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text">want Clippy to crash on your code and we want it to be as reliable as the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text">suggestions from Rust compiler errors.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text">We have prioritization labels and a sync-blocker label, which are described below.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text">- [P-low][p-low]: Requires attention (fix/response/evaluation) by a team member but isn't urgent.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text">- [P-medium][p-medium]: Should be addressed by a team member until the next sync.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text">- [P-high][p-high]: Should be immediately addressed and will require an out-of-cycle sync or a backport.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text">- [L-sync-blocker][l-sync-blocker]: An issue that &quot;blocks&quot; a sync.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text">Or rather: before the sync this should be addressed,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text">e.g. by removing a lint again, so it doesn't hit beta/stable.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text">## Bors and Homu</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text">We use a bot powered by [Homu][homu] to help automate testing and landing of pull</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text">requests in Clippy. The bot's username is @bors.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text">You can find the Clippy bors queue [here][homu_queue].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text">If you have @bors permissions, you can find an overview of the available</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text">commands [here][homu_instructions].</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text">[triage]: https://forge.rust-lang.org/release/triage-procedure.html</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text">[l-crash]: https://github.com/rust-lang/rust-clippy/labels/L-crash</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text">[l-bug]: https://github.com/rust-lang/rust-clippy/labels/L-bug</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text">[p-low]: https://github.com/rust-lang/rust-clippy/labels/P-low</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text">[p-medium]: https://github.com/rust-lang/rust-clippy/labels/P-medium</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text">[p-high]: https://github.com/rust-lang/rust-clippy/labels/P-high</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text">[l-sync-blocker]: https://github.com/rust-lang/rust-clippy/labels/L-sync-blocker</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text">[homu]: https://github.com/rust-lang/homu</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text">[homu_instructions]: https://bors.rust-lang.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text">[homu_queue]: https://bors.rust-lang.org/queue/clippy</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text">## Contributions</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text">Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text">be reviewed by a core contributor (someone with permission to land patches) and either landed in the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text">main tree or given feedback for changes that would be required.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text">All PRs should include a `changelog` entry with a short comment explaining the change. The rule of thumb is basically,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text">&quot;what do you believe is important from an outsider's perspective?&quot; Often, PRs are only related to a single property of a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text">lint, and then it's good to mention that one. Otherwise, it's better to include too much detail than too little.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text">Clippy's [changelog] is created from these comments. Every release, someone gets all commits from bors with a</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text">`changelog: XYZ` entry and combines them into the changelog. This is a manual process.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text">Examples:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text">- New lint</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text">  ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text">  changelog: new lint: [`missing_trait_methods`]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text">  ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text">- False positive fix</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text">  ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text">  changelog: Fix [`unused_peekable`] false positive when peeked in a closure or called as `f(&amp;mut peekable)`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text">  ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text">- Purely internal change</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text">  ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text">  changelog: none</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text">  ```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text">Note this it is fine for a PR to include multiple `changelog` entries, e.g.:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text">changelog: Something 1</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text">changelog: Something 2</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text">changelog: Something 3</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text">[changelog]: CHANGELOG.md</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text">## License</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text">All code in this repository is under the [Apache-2.0] or the [MIT] license.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text">&lt;!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md --&gt;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text">[Apache-2.0]: https://www.apache.org/licenses/LICENSE-2.0</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text">[MIT]: https://opensource.org/licenses/MIT</span></span></pre></div></div>
</main>
</body>
</html>
