Skip to content

Commit 469c030

Browse files
Update CONTRIBUTING.md
Fixes #77215 As mentioned in #77215, the current CONTRIBUTING.md links to the rustc-dev-guide. Even though the rustc-dev-guide has lots of useful information for contributors, one is already confused by reading the first line of the current CONTRIBUTING.md. > To get started, read the [Getting Started] guide in the [rustc-dev-guide]. This line tells the contributor to go and read the rustc-dev-guide. What is the rustc-dev-guide? What does rustc even mean? These are some of the questions that went into my head when reading this line as a first time contributor. By explaining what the rustc-dev-guide is and some platforms to get help, a new contributor understands what the first step is and the process is much clearer. The `About the [rustc-dev-guide]` section explains what the rustc-dev-guide is, what rustc is, and the purpose out of reading the guide. The `Getting help` section points the user to some places where they can get help, find a mentor, and introduce themsevles.
1 parent 1279b3b commit 469c030

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

CONTRIBUTING.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
# Contributing to Rust
22

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

56
To get started, read the [Contributing to Rust] chapter of the [rustc-dev-guide].
67

8+
## About the [rustc-dev-guide]
9+
10+
The [rustc-dev-guide] is meant to help document how rustc –the Rust compiler– works,
11+
as well as to help new contributors get involved in rustc development. It is recommend
12+
to read and understand the [rustc-dev-guide] before making a contribution. This guide
13+
talks about the different bots in the Rust ecosystem, the Rust development tools,
14+
bootstrapping, the compiler architecture, source code representation, and more.
15+
16+
## [Getting help](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions)
17+
18+
There are many ways you can get help when you're stuck. Rust has many platforms for this:
19+
[internals], [rust-zulip], and [rust-discord]. It is recommended to ask for help on
20+
the [rust-zulip], but any of these platforms are a great way to seek help and even
21+
find a mentor! You can learn more about asking questions and getting help in the
22+
[Asking Questions](https://rustc-dev-guide.rust-lang.org/getting-started.html#asking-questions) chapter of the [rustc-dev-guide].
23+
724
## Bug reports
825

926
Did a compiler error message tell you to come here? If you want to create an ICE report,
@@ -13,3 +30,6 @@ refer to [this section][contributing-bug-reports] and [open an issue][issue temp
1330
[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/
1431
[contributing-bug-reports]: https://rustc-dev-guide.rust-lang.org/contributing.html#bug-reports
1532
[issue template]: https://github.com/rust-lang/rust/issues/new/choose
33+
[internals]: https://internals.rust-lang.org
34+
[rust-discord]: http://discord.gg/rust-lang
35+
[rust-zulip]: https://rust-lang.zulipchat.com

0 commit comments

Comments
 (0)