<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>src/tools/clippy/.github/PULL_REQUEST_TEMPLATE.md - fork/rust @ master</title>
<meta name="description" content="src/tools/clippy/.github/PULL_REQUEST_TEMPLATE.md in fork/rust at master.">
<meta property="og:title" content="src/tools/clippy/.github/PULL_REQUEST_TEMPLATE.md - fork/rust @ master">
<meta property="og:description" content="src/tools/clippy/.github/PULL_REQUEST_TEMPLATE.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> / <a href="/fork/rust/ref/master/tree/src/tools/clippy/.github/">.github</a> / <span class="cur">PULL_REQUEST_TEMPLATE.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>39 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/9e49f60892d26490c047173c568d15e9690f82e3/src/tools/clippy/.github/PULL_REQUEST_TEMPLATE.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"><p>Thank you for making Clippy better!</p>
<p>We're collecting our changelog from pull request descriptions.
If your PR only includes internal changes, you can just write
<code>changelog: none</code>. Otherwise, please write a short comment
explaining your change.</p>
<p>It's also helpful for us that the lint name is put within backticks (<code>` `</code>),
and then encapsulated by square brackets (<code>[]</code>), for example:</p>
<pre>changelog: [`lint_name`]: your change
</pre>
<p>If your PR fixes an issue, you can add <code>fixes #issue_number</code> into this
PR description. This way the issue will be automatically closed when
your PR is merged.</p>
<p>If you added a new lint, here's a checklist for things that will be
checked during review or continuous integration.</p>
<ul>
<li>[ ] Followed <a href="https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints">lint naming conventions</a></li>
<li>[ ] Added passing UI tests (including committed <code>.stderr</code> file)</li>
<li>[ ] <code>cargo test</code> passes locally</li>
<li>[ ] Executed <code>cargo dev update_lints</code></li>
<li>[ ] Added lint documentation</li>
<li>[ ] Run <code>cargo dev fmt</code></li>
</ul>
<p>Note that you can skip the above if you are just opening a WIP PR in
order to get feedback.</p>
<p>Delete this line and everything above before opening your PR.</p>
<hr />
<p><em>Please write a short comment explaining your change (or "none" for internal only changes)</em></p>
<p>changelog:</p>
</section><div class="code-panel"><pre class="code src" data-hl="src/tools/clippy/.github/PULL_REQUEST_TEMPLATE.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text">Thank you for making Clippy better!</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">We're collecting our changelog from pull request descriptions.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">If your PR only includes internal changes, you can just write</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">`changelog: none`. Otherwise, please write a short comment</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">explaining your 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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">It's also helpful for us that the lint name is put within backticks (`` ` ` ``),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">and then encapsulated by square brackets (`[]`), for example:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">```</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">changelog: [`lint_name`]: your change</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">If your PR fixes an issue, you can add `fixes #issue_number` into this</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">PR description. This way the issue will be automatically closed when</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">your PR is merged.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">If you added a new lint, here's a checklist for things that will be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">checked during review or continuous integration.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">- \[ ] Followed [lint naming conventions][lint_naming]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text">- \[ ] Added passing UI tests (including committed `.stderr` file)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">- \[ ] `cargo test` passes locally</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text">- \[ ] Executed `cargo dev update_lints`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">- \[ ] Added lint documentation</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">- \[ ] Run `cargo dev fmt`</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">[lint_naming]: https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">Note that you can skip the above if you are just opening a WIP PR in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">order to get feedback.</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">Delete this line and everything above before opening your PR.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">*Please write a short comment explaining your change (or &quot;none&quot; for internal only changes)*</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">changelog:</span></span></pre></div></div>
</main>
</body>
</html>
