]> git.lizzy.rs Git - rust.git/commit
Rollup merge of #82887 - henryboisdequin:improve-contributing-md, r=joshtriplett
authorMara Bos <m-ou.se@m-ou.se>
Tue, 9 Mar 2021 09:05:27 +0000 (09:05 +0000)
committerGitHub <noreply@github.com>
Tue, 9 Mar 2021 09:05:27 +0000 (09:05 +0000)
commit74de9db0ce515a26171c441cd808e6d872010f86
tree2d80555f16636c76ee9e5d452078c13f19cc1f4a
parentbf1580279e1f548917ddfc9eaff248c3d153875e
parentbf40ac68777870bbb0336d51f06082f288262dcd
Rollup merge of #82887 - henryboisdequin:improve-contributing-md, r=joshtriplett

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 themselves.