Consolidate, deduplicate, and link information for getting started #1653
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
"Getting Started" is already *very* long; this shrinks it a bit, and puts similar info closer together.
This is advanced info that most contributors won't need to know; and for experienced contributors, it means the info is at the top of the page instead of needing to scroll.
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.
jyn514
force-pushed
the
smaller-getting-started
branch
from
386a204 to
5ce68b8
Compare
JohnTitor
added
the
S-waiting-on-review
camelid
reviewed
Mar 28, 2023
This was referenced Mar 30, 2023
|
bump - does anyone have objections to merging this? |
JohnTitor
approved these changes
Apr 3, 2023
bors
added a commit
to rust-lang/rust-clippy
that referenced
this pull request
Apr 3, 2023
Update subtree sync docs for changes in rustc-dev-guide Companion PR to rust-lang/rustc-dev-guide#1653. That still keeps a `contributing.html` with an "External Contributions" section, so hopefully it won't be too disruptive. changelog: none
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Apr 3, 2023
…ulacrum Update contributing links for rustc-dev-guide changes Companion PR to rust-lang/rustc-dev-guide#1653. - Remove unused reference link in CONTRIBUTING.md - Change the contributing_url for triagebot to the getting started page
oli-obk
pushed a commit
to oli-obk/miri
that referenced
this pull request
Apr 4, 2023
Update contributing links for rustc-dev-guide changes Companion PR to rust-lang/rustc-dev-guide#1653. - Remove unused reference link in CONTRIBUTING.md - Change the contributing_url for triagebot to the getting started page
RalfJung
reviewed
Apr 6, 2023
| Building Rust will also use external git repositories tracked using [git | ||
| submodules]. The complete list may be found in the [`.gitmodules`] file. Some | ||
| of these projects are required (like `stdarch` for the standard library) and | ||
| some of them are optional (like [Miri]). |
There was a problem hiding this comment.
This still indicates that Miri is a submodule, and is allowed to fail -- which is not true any more.
RalfJung
reviewed
Apr 6, 2023
|
|
||
| Rust's build system builds a number of tools that make use of the internals of | ||
| the compiler and that are hosted in a separate repository, and included in Rust | ||
| via git submodules (such as [Miri]). If these tools break because of your |
There was a problem hiding this comment.
Another stray reference to a Miri submodule
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1455.
I highly recommend reviewing this commit-by-commit, as well as using Tips for reviewing - Moving large sections of code.
Move some info out of "Getting Started" to "How to build and run"
"Getting Started" is already very long; this shrinks it a bit, and
puts similar info closer together.
Outline the external repositories section
This is advanced info that most contributors won't need to know; and for experienced contributors, it means the info is at the top of the page
instead of needing to scroll.
Rearrange the "getting started" and contributing.md sections
There was a lot of information duplicated between the two, and it wasn't clear which one to look at. This changes
contributing.mdto 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.mdrather thanspreading them between about-this-guide, getting-started, and
contributing.
Link to bug-fix-procedure.md from the contribution procedure section
Remove duplicate section on new features in CONTRIBUTING.md
Add a few more TOC sections