squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity
rust/CONTRIBUTING.md
Joshua Nelson a06e5decaf Link to other resources instead of inlining their information 
The other places are more accurate and up-to-date.

- Link to `std-dev-guide` in CONTRIBUTING.md

  Thom and Mara said the guide is in reasonably good shape, and it's tailored more closely to people working on the standard library.

- Link to CONTRIBUTING.md instead of rustc-dev-guide in the main readme

  CONTRIBUTING.md has more information and also links the std-dev-guide.

- Link to forge for the list of tested platforms; the one in the readme
  was hopelessly out of date.
2022-12-23 19:03:50 -06:00

2.4 KiB
Raw Permalink Blame History

Contributing to Rust

Thank you for your interest in contributing to Rust! There are many ways to contribute and we appreciate all of them.

The best way to get started is by asking for help in the #new members 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 ask for help.

Documentation for contributing to the compiler or tooling is located in the Guide to Rustc Development, commonly known as the rustc-dev-guide. Documentation for the standard library in the Standard library developers Guide, commonly known as the std-dev-guide.

About the rustc-dev-guide

The rustc-dev-guide 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 rustc-dev-guide 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.

Getting help

There are many ways you can get help when you're stuck. Rust has many platforms for this: internals, rust-zulip, and rust-discord. It is recommended to ask for help on the rust-zulip, 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 Asking Questions chapter of the rustc-dev-guide.

Bug reports

Did a compiler error message tell you to come here? If you want to create an ICE report, refer to this section and open an issue.