<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CONTRIBUTING.md - fork/rust @ master</title>
<meta name="description" content="CONTRIBUTING.md in fork/rust at master.">
<meta property="og:title" content="CONTRIBUTING.md - fork/rust @ master">
<meta property="og:description" content="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> / <span class="cur">CONTRIBUTING.md</span></nav>
<span class="view-stats"><span>2.3 KiB</span><span>42 lines</span></span><span class="actions"><a class="raw" href="/fork/rust/raw/dfaa70bb9db005a2d79c5064f57d95640e2af079/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 Rust</h1>
<p>Thank you for your interest in contributing to Rust! There are many ways to contribute
and we appreciate all of them.</p>
<p>The best way to get started is by asking for help in the <a href="https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members">#new
members</a>
Zulip stream. We have lots of docs below of how to get started on your own, but
the Zulip stream is the best place to <em>ask</em> for help.</p>
<p>Documentation for contributing to the compiler or tooling is located in the <a href="https://rustc-dev-guide.rust-lang.org/">Guide to Rustc
Development</a>, commonly known as the <a href="https://rustc-dev-guide.rust-lang.org/">rustc-dev-guide</a>. Documentation for the
standard library in the <a href="https://std-dev-guide.rust-lang.org/">Standard library developers Guide</a>, commonly known as the <a href="https://std-dev-guide.rust-lang.org/">std-dev-guide</a>.</p>
<h2>About the <a href="https://rustc-dev-guide.rust-lang.org/">rustc-dev-guide</a></h2>
<p>The <a href="https://rustc-dev-guide.rust-lang.org/">rustc-dev-guide</a> is meant to help document how rustc –the Rust compiler– works,
as well as to help new contributors get involved in rustc development. It is recommend
to read and understand the <a href="https://rustc-dev-guide.rust-lang.org/">rustc-dev-guide</a> before making a contribution. This guide
talks about the different bots in the Rust ecosystem, the Rust development tools,
bootstrapping, the compiler architecture, source code representation, and more.</p>
<h2><a href="https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions">Getting help</a></h2>
<p>There are many ways you can get help when you're stuck. Rust has many platforms for this:
<a href="https://internals.rust-lang.org">internals</a>, <a href="https://rust-lang.zulipchat.com">rust-zulip</a>, and <a href="http://discord.gg/rust-lang">rust-discord</a>. It is recommended to ask for help on
the <a href="https://rust-lang.zulipchat.com">rust-zulip</a>, but any of these platforms are a great way to seek help and even
find a mentor! You can learn more about asking questions and getting help in the
<a href="https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions">Asking Questions</a> chapter of the <a href="https://rustc-dev-guide.rust-lang.org/">rustc-dev-guide</a>.</p>
<h2>Bug reports</h2>
<p>Did a compiler error message tell you to come here? If you want to create an ICE report,
refer to <a href="https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports">this section</a> and <a href="https://github.com/rust-lang/rust/issues/new/choose">open an issue</a>.</p>
</section><div class="code-panel"><pre class="code src" data-hl="CONTRIBUTING.md"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"># Contributing to Rust</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">Thank you for your interest in contributing to Rust! There are many ways to contribute</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">and we appreciate all of them.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">The best way to get started is by asking for help in the [#new</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">members](https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">Zulip stream. We have lots of docs below of how to get started on your own, but</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">the Zulip stream is the best place to *ask* for help.</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">Documentation for contributing to the compiler or tooling is located in the [Guide to Rustc</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text">Development][rustc-dev-guide], commonly known as the [rustc-dev-guide]. Documentation for the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">standard library in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide].</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">## About the [rustc-dev-guide]</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">The [rustc-dev-guide] is meant to help document how rustc –the Rust compiler– works,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text">as well as to help new contributors get involved in rustc development. It is recommend</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">to read and understand the [rustc-dev-guide] before making a contribution. This guide</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">talks about the different bots in the Rust ecosystem, the Rust development tools,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">bootstrapping, the compiler architecture, source code representation, and more.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">## [Getting help](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text">There are many ways you can get help when you're stuck. Rust has many platforms for this:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text">[internals], [rust-zulip], and [rust-discord]. It is recommended to ask for help on</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text">the [rust-zulip], but any of these platforms are a great way to seek help and even</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">find a mentor! You can learn more about asking questions and getting help in the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">[Asking Questions](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions) chapter of the [rustc-dev-guide].</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">## Bug reports</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">Did a compiler error message tell you to come here? If you want to create an ICE report,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">refer to [this section][contributing-bug-reports] and [open an issue][issue template].</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">[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">[std-dev-guide]: https://std-dev-guide.rust-lang.org/</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">[contributing-bug-reports]: https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text">[issue template]: https://github.com/rust-lang/rust/issues/new/choose</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">[internals]: https://internals.rust-lang.org</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">[rust-discord]: http://discord.gg/rust-lang</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text">[rust-zulip]: https://rust-lang.zulipchat.com</span></span></pre></div></div>
</main>
</body>
</html>
