CONTRIBUTING.md

   1 # Contributing to Rust
   2
   3 Thank you for your interest in contributing to Rust! There are many ways to contribute
   4 and we appreciate all of them.
   5
   6 The best way to get started is by asking for help in the [#new
   7 members](https://rust-lang.zulipchat.com/#narrow/stream/122652-new-members)
   8 Zulip stream. We have lots of docs below of how to get started on your own, but
   9 the Zulip stream is the best place to *ask* for help.
  10
  11 Documentation for contributing to the compiler or tooling is located in the [Guide to Rustc
  12 Development][rustc-dev-guide], commonly known as the [rustc-dev-guide]. Documentation for the
  13 standard library in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide].
  14
  15 ## About the [rustc-dev-guide]
  16
  17 The [rustc-dev-guide] is meant to help document how rustc –the Rust compiler– works,
  18 as well as to help new contributors get involved in rustc development. It is recommend
  19 to read and understand the [rustc-dev-guide] before making a contribution. This guide
  20 talks about the different bots in the Rust ecosystem, the Rust development tools,
  21 bootstrapping, the compiler architecture, source code representation, and more.
  22
  23 ## [Getting help](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions)
  24
  25 There are many ways you can get help when you're stuck. Rust has many platforms for this:
  26 [internals], [rust-zulip], and [rust-discord]. It is recommended to ask for help on
  27 the [rust-zulip], but any of these platforms are a great way to seek help and even
  28 find a mentor! You can learn more about asking questions and getting help in the
  29 [Asking Questions](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions) chapter of the [rustc-dev-guide].
  30
  31 ## Bug reports
  32
  33 Did a compiler error message tell you to come here? If you want to create an ICE report,
  34 refer to [this section][contributing-bug-reports] and [open an issue][issue template].
  35
  36 [Contributing to Rust]: https://rustc-dev-guide.rust-lang.org/contributing.html#contributing-to-rust
  37 [rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/
  38 [std-dev-guide]: https://std-dev-guide.rust-lang.org/
  39 [contributing-bug-reports]: https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports
  40 [issue template]: https://github.com/rust-lang/rust/issues/new/choose
  41 [internals]: https://internals.rust-lang.org
  42 [rust-discord]: http://discord.gg/rust-lang
  43 [rust-zulip]: https://rust-lang.zulipchat.com