Commit graph

2081 commits

Author SHA1 Message Date
lcnr
c83eb53b16 extend the sixth requirement 2023-04-26 12:09:10 -07:00
Lukas Wirth
6292408823 Add docs for compare-output-lines-by-subset flag (#1677) 2023-04-22 20:50:11 +09:00
Tshepang Mbambo
6a1ec81e08 fix typo (#1674) 2023-04-22 20:49:13 +09:00
Brian Kung
624f9293f0 Fix links in how-to-build-and-run.md (#1679) 2023-04-22 20:48:44 +09:00
Ezra Shaw
75ec4ccb0e docs: document new suggest-tests tool 2023-04-16 13:56:19 +02:00
Ohad Ravid
3554a5fa04 Fix extra slash 2023-04-16 13:30:24 +02:00
Tshepang Mbambo
7c0f2d93d5 fix markup (#1670) 2023-04-10 23:23:05 +09:00
Joshua Nelson
dd6b64dcd2 Link to governance page
It has links to the specific channel/stream for each team.
2023-04-09 22:38:15 +02:00
jyn
bb9851f5d8 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
69eb29be99 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
24a895c74d 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
bed44e0e2c Fix link; remove duplicate link 2023-04-09 22:38:15 +02:00
jyn
09b1d00c59 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
173f912c22 Clarify cfg(bootstrap) docs 2023-04-09 21:38:54 +02:00
jyn
0cb4e860e1 document that it's rare for books to break 2023-04-09 21:20:55 +02:00
jyn
7234174cdc 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
a148002920 fix incorrect miri mentions in "External Repos" chapter 2023-04-09 21:20:55 +02:00
jyn
4e90ab20ce Improve the landing page for contributing to the libstd docs (#1666) 2023-04-09 12:10:27 +09:00
jyn
8c838fb2fb Various improvements to check_line_lengths.sh (#1667) 2023-04-09 12:08:46 +09:00
jyn
41dac679da Document how to ignore specific files in a diff (#1668) 2023-04-09 12:07:16 +09:00
y21
8cafe9b652 fix line length 2023-04-05 19:29:18 -05:00
y21
715a3f869d mention git clone --depth 2023-04-05 19:29:18 -05:00
Joshua Nelson
5c91a8bf8b add a few more TOC sections 2023-04-03 06:42:31 -05:00
Joshua Nelson
8ddce2bff8 Remove duplicate section on new features in CONTRIBUTING.md 2023-04-03 06:42:31 -05:00
Joshua Nelson
d15131c30c Link to bug-fix-procedure.md from the contribution procedure section 2023-04-03 06:42:31 -05:00
Joshua Nelson
0d667ddb24 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
c13d277aca 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
4694e1802a 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
50cee01f09 Make REUSE ignore section heading as a copyright statement (#1659) 2023-04-03 20:09:34 +09:00
Eric Huss
920e282736 Update some links and information for cargo-bisect-rustc (#1657) 2023-04-02 15:15:55 +09:00
Tshepang Mbambo
09c828b188 update rustc_driver examples (#1655) 2023-04-01 09:35:35 -04:00
Nathan Hammond
4bd5748f9f Add locale_resources (#1651) 2023-03-26 12:55:53 -05:00
jyn
56c1d301b4 Don't require $GITHUB_TOKEN to build locally (#1652) 2023-03-27 00:28:07 +09:00
Shahar Dawn Or
52dd6d812a bootsrapping stages overview list 2023-03-23 15:36:00 +02:00
Eric Huss
96c90f8dba Update labels overview (#1639) 2023-03-21 18:07:36 +09:00
Tshepang Mbambo
8448fc10e6 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
f245189482 Add SIP solution for macOS users (#1636) 2023-03-21 17:50:39 +09:00
Langston Barrett
b146ed6765 Reword to include 'distractions' 2023-03-16 18:40:40 -07:00
Langston Barrett
c9513359da Mention debug assertions label 2023-03-16 18:40:40 -07:00
Langston Barrett
0eb0d25f26 Mention debug assertions 2023-03-16 18:40:40 -07:00
Langston Barrett
7dedcf9ade Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett
4b03d9f774 mir-opt*-level*, not mir-opt 2023-03-16 18:40:40 -07:00
Langston Barrett
c40d443244 Address review comments 2023-03-16 18:40:40 -07:00
Langston Barrett
4807498a0d Add chapter on fuzzing 2023-03-16 18:40:40 -07:00
Hoblovski
f93e81c854 Fix "Crate disambiguator" in libs-and-metadata.md 2023-03-16 11:11:46 +02:00
Tshepang Mbambo
8bcd15e640 alert when date gets stale (by using date-check annotation) 2023-03-14 05:50:20 +02:00
Tshepang Mbambo
3e6740a703 fix date-check annotation some more 2023-03-14 05:50:20 +02:00
Tshepang Mbambo
43fc233e13 fix date-check annotation 2023-03-14 05:50:20 +02:00
Tshepang Mbambo
dd1d0cd1dc typo 2023-03-14 05:50:20 +02:00
Michael Howell
f1faa1139f Update rustdoc-internals.md 2023-03-14 05:50:20 +02:00