Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md #82887

Merged
merged 2 commits into from
Mar 9, 2021
Merged

Update CONTRIBUTING.md #82887

merged 2 commits into from
Mar 9, 2021

Commits on Mar 9, 2021

  1. Update CONTRIBUTING.md 

    Fixes rust-lang#77215

As mentioned in rust-lang#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.
    @henryboisdequin
    henryboisdequin committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    469c030 View commit details
    Browse the repository at this point in the history

  2. Make opening sentence friendlier for new contributors 

    Co-authored-by: Camelid <camelidcamel@gmail.com>
    @henrytheswimmer @camelid @henryboisdequin
    2 people authored and henryboisdequin committed Mar 9, 2021
    Configuration menu
    Copy the full SHA
    bf40ac6 View commit details
    Browse the repository at this point in the history