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 Documentation for contributing to Rust is located in the [Guide to Rustc Development](https://rustc-dev-guide.rust-lang.org/),
   7 commonly known as the [rustc-dev-guide]. Despite the name, this guide documents
   8 not just how to develop rustc (the Rust compiler), but also how to contribute to any part
   9 of the Rust project.
  10
  11 To get started with contributing, please read the [Contributing to Rust] chapter of the guide.
  12 That chapter explains how to get your development environment set up and how to get help.
  13
  14 ## About the [rustc-dev-guide]
  15
  16 The [rustc-dev-guide] is meant to help document how rustc –the Rust compiler– works,
  17 as well as to help new contributors get involved in rustc development. It is recommend
  18 to read and understand the [rustc-dev-guide] before making a contribution. This guide
  19 talks about the different bots in the Rust ecosystem, the Rust development tools,
  20 bootstrapping, the compiler architecture, source code representation, and more.
  21
  22 ## [Getting help](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions)
  23
  24 There are many ways you can get help when you're stuck. Rust has many platforms for this:
  25 [internals], [rust-zulip], and [rust-discord]. It is recommended to ask for help on
  26 the [rust-zulip], but any of these platforms are a great way to seek help and even
  27 find a mentor! You can learn more about asking questions and getting help in the
  28 [Asking Questions](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions) chapter of the [rustc-dev-guide].
  29
  30 ## Bug reports
  31
  32 Did a compiler error message tell you to come here? If you want to create an ICE report,
  33 refer to [this section][contributing-bug-reports] and [open an issue][issue template].
  34
  35 [Contributing to Rust]: https://rustc-dev-guide.rust-lang.org/contributing.html#contributing-to-rust
  36 [rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/
  37 [contributing-bug-reports]: https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports
  38 [issue template]: https://github.com/rust-lang/rust/issues/new/choose
  39 [internals]: https://internals.rust-lang.org
  40 [rust-discord]: http://discord.gg/rust-lang
  41 [rust-zulip]: https://rust-lang.zulipchat.com