This is the first question I get from nearly all contributors. So far
I've been giving links to individual issues, but they quickly go out of
date or get fixed, and then I have more work to do to help people find
an issue. Add some suggestions for work people can find themselves,
without having to first consult an expert.
This also moves the "Cloning and Building" stub to the bottom of the
page.
There was a lot of information duplicated between the two, and it wasn't
clear which one to look. This commit changes `contributing.md` to be
strictly for contribution procedures, and moves "what should I work on"
sections to "Getting Started".
This also consolidates the links in `about-this-guide.md` rather than
spreading them between about-this-guide, getting-started, and
contributing.
I suggest using https://rustc-dev-guide.org/git.html#moving-large-sections-of-code to review this commit.
This is a follow-up to #1279.
The "Getting Started" chapter is, TBH, pretty bad when it comes to the
stuff about building and testing. It has far too much detail and lots of
repetition, which would be overwhelming to a newcomer.
This commit removes most of it, leaving behind just quick mentions of
the most common `x.py` commands: `check`, `build`, `test`, `fmt`, with
links to the appropriate chapters for details. There were a few
interesting details that weren't covered elsewhere, so I moved those
into other chapters.
* Move `x.py` intro section before first use, and shorten it.
* Improve `x.py setup` docs.
In "Getting Started", strip it back to the bare minimum. Some of this is
moved into the later section.
In the later section, add notable details like config.toml.example how
and `profile` works. Also make the config.toml example more concise.
* Move details about the repository.
Less detail in "Getting Started", more in the later sections.
* Move details about the prereqs.
Less detail in "Getting Started", more in the later sections.
A link to the relevant section of the contributing documentation makes it easier for contributors to locate the relevant information. (e.g. via an in-page search for "doc".)
This is particularly important currently as 85072e3303/CONTRIBUTING.md links directly to the (currently `rustc`-focused) "Getting Started" guide rather than the general Rust contribution content to which it used to point.
Jakub Beránek
Jakub Beránek
Emanuel Czirai
Yuki Okushi
Santiago Pastorino
Aneesh
zahash
İsmail Arılık
jyn
Ohad Ravid
jyn
Tshepang Mbambo
ozkanonur
Eric Huss
pierwill
Nicholas Nethercote
Lucas Kent
Ken Matsui
Noah Lev
Oli Scherer
Frank Steffahn
Daniel Santos
Iñaki Garay
ashosive
saki-osive
Ryan Levick
Yuki Okushi
Stu
LeSeulArtichaut
Roman
Joshua Nelson
follower