Commit Graph

2073 Commits

Author SHA1 Message Date
jyn df1d869b36 Apply suggestions from code review
Thank you JohnTitor for finding these!

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-04-09 22:38:15 +02:00
jyn 65541fee89 Add a "What should I work on?" section
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.
2023-04-09 22:38:15 +02:00
jyn e32c45adea Make the "Asking Questions" section more useful
- Update outdated chat platforms
- Link to the community page
- Suggest `git shortlog` for finding experts
2023-04-09 22:38:15 +02:00
jyn a5f0310ba4 Fix link; remove duplicate link 2023-04-09 22:38:15 +02:00
jyn b6e5e27f3a Move "Getting Started" to the first page
This page is better suited for people landing immediately from
CONTRIBUTING.md, or who haven't heard of the guide before. "About This
Guide" is still useful, but doesn't need to be the very first page.
2023-04-09 22:38:15 +02:00
jyn bea76af07d Clarify cfg(bootstrap) docs 2023-04-09 21:38:54 +02:00
jyn ff78970088 document that it's rare for books to break 2023-04-09 21:20:55 +02:00
jyn 558a4f3d06 Remove detailed toolstate section
This is already covered in detail on Forge: https://forge.rust-lang.org/infra/toolstate.html
and linked in the previous paragraph.
2023-04-09 21:20:55 +02:00
jyn 54a87876bd fix incorrect miri mentions in "External Repos" chapter 2023-04-09 21:20:55 +02:00
jyn e379577fd0 Improve the landing page for contributing to the libstd docs (#1666) 2023-04-09 12:10:27 +09:00
jyn c6cd62cf77 Various improvements to `check_line_lengths.sh` (#1667) 2023-04-09 12:08:46 +09:00
jyn 088c7fec78 Document how to ignore specific files in a diff (#1668) 2023-04-09 12:07:16 +09:00
y21 297817bf1f fix line length 2023-04-05 19:29:18 -05:00
y21 42b4a3b105 mention `git clone --depth` 2023-04-05 19:29:18 -05:00
Joshua Nelson 1fd8ddbdc2 add a few more TOC sections 2023-04-03 06:42:31 -05:00
Joshua Nelson 945da7bd13 Remove duplicate section on new features in CONTRIBUTING.md 2023-04-03 06:42:31 -05:00
Joshua Nelson 161b9b3beb Link to bug-fix-procedure.md from the contribution procedure section 2023-04-03 06:42:31 -05:00
Joshua Nelson 92102e0e8c 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. 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.
2023-04-03 06:42:31 -05:00
Joshua Nelson cdd2e49a7a 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.
2023-04-03 06:42:31 -05:00
Joshua Nelson 774a20130a Move some info from "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.
2023-04-03 06:42:31 -05:00
Pietro Albini 030739585a Make REUSE ignore section heading as a copyright statement (#1659) 2023-04-03 20:09:34 +09:00
Eric Huss 0cb6011623 Update some links and information for cargo-bisect-rustc (#1657) 2023-04-02 15:15:55 +09:00
Tshepang Mbambo 7cb957b26f update rustc_driver examples (#1655) 2023-04-01 09:35:35 -04:00
Nathan Hammond 1a0aa9321a Add locale_resources (#1651) 2023-03-26 12:55:53 -05:00
jyn b4b007be06 Don't require $GITHUB_TOKEN to build locally (#1652) 2023-03-27 00:28:07 +09:00
Shahar Dawn Or 266ca693c0 bootsrapping stages overview list 2023-03-23 15:36:00 +02:00
Eric Huss ccef9cb8e1 Update labels overview (#1639) 2023-03-21 18:07:36 +09:00
Tshepang Mbambo ed855b1a00 first mention of type, and add a link (#1643)
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2023-03-21 17:55:42 +09:00
Yukang e6289be8dc Add SIP solution for macOS users (#1636) 2023-03-21 17:50:39 +09:00
Langston Barrett 69dbbd548d Reword to include 'distractions' 2023-03-16 18:40:40 -07:00
Langston Barrett 0a4cfa8e4b Mention debug assertions label 2023-03-16 18:40:40 -07:00
Langston Barrett 2848aadbff Mention debug assertions 2023-03-16 18:40:40 -07:00
Langston Barrett f49ec954c5 Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett d09a940816 mir-opt*-level*, not mir-opt 2023-03-16 18:40:40 -07:00
Langston Barrett 5de7dd6e4f Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett 5531ed7c5e Add chapter on fuzzing 2023-03-16 18:40:40 -07:00
Hoblovski f946bd407f Fix "Crate disambiguator" in libs-and-metadata.md 2023-03-16 11:11:46 +02:00
Tshepang Mbambo 82a5c6d47b alert when date gets stale (by using date-check annotation) 2023-03-14 05:50:20 +02:00
Tshepang Mbambo 1ffcb23bbc fix date-check annotation some more 2023-03-14 05:50:20 +02:00
Tshepang Mbambo fa092136c0 fix date-check annotation 2023-03-14 05:50:20 +02:00
Tshepang Mbambo ea585370c8 typo 2023-03-14 05:50:20 +02:00
Michael Howell ba285c2370 Update rustdoc-internals.md 2023-03-14 05:50:20 +02:00
Thom Chiovoloni 31991ba0cb Rename `config.toml.example` to `config.example.toml` 2023-03-13 04:42:00 +02:00
Yutaro Ohno c5ec776f41 fix typo `SubstRef` to `SubstsRef` 2023-03-12 11:40:45 +02:00
Tshepang Mbambo 060b7a17dc improve accuracy 2023-03-10 09:04:21 +02:00
bohan 1b7cd1e2bf tracing log along diff crates 2023-03-10 09:04:21 +02:00
clubby789 88a1bdd470 Fix Rust Analyzer settings location
This file was moved in https://github.com/rust-lang/rust/pull/108618
2023-03-08 00:21:21 +02:00
Yuki Okushi 70e8b3e396 Reflect the changes in rust-lang/rust#67000 (#1632)
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-06 14:22:07 -03:00
Tshepang Mbambo cee03b4dc3 improve capacity note (#1634) 2023-03-06 22:08:37 +09:00
Yuki Okushi b46fe5900b Remove mention to lexer/parser refactoring
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2023-03-03 17:41:21 +02:00