Commit Graph

2103 Commits

Author SHA1 Message Date
jyn fa57b7b94e move the Breaking Changes section later in the guide 2023-06-29 10:05:10 -05:00
jyn 9618be3aa7 distinguish language and library processes more consistently 2023-06-29 10:05:10 -05:00
jyn 6578c56f30 Move "Adding a new feature gate" to the "Implementing new features" chapter
Splitting the two was confusing and meant that similar information was in wildly different parts of the guide. Combine them into a single page.
2023-06-29 10:05:10 -05:00
Eric Huss c242e5719c Reword `messages.ftl` example. 2023-06-29 06:43:19 +02:00
Eric Huss 1b6f93987d Fix some links 2023-06-29 06:43:19 +02:00
Tshepang Mbambo b4ecfbc298 fix link 2023-06-28 06:55:24 +02:00
Eric Huss 51f6fe2a1a Define more lint terms 2023-06-28 06:55:24 +02:00
Oleksandr Babak ef3a819b4c fix_typo 2023-06-26 18:34:26 +02:00
Tshepang Mbambo b6c87310d1 run-make tests: fix and improve (#1702) 2023-06-26 23:03:03 +09:00
lcnr d42b320daa add stub for proof trees (#1700) 2023-06-23 23:40:25 +01:00
Zyranivia da1de802ba Update track_caller reference link (#1688) 2023-06-21 18:14:16 +09:00
Zachary Whiteley 93fc2f3c01 Include information about setup defaults in how-to-build guide (#1694) 2023-06-21 18:13:53 +09:00
Caleb Robson 4b15de4985 Fix typo (#1697)
* Fix typo

* Fix typo in typo fix

* add missing word

---------

Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>
2023-06-14 06:43:09 +02:00
Ewan Breakey 11bc8caeb7 Fix typo in thir.md 2023-06-13 21:18:46 -07:00
Eric Huss ebb0fd2147 Update triagebot links. 2023-06-13 20:49:13 +02:00
Arthur Cohen 4497151da5 name-resolution: Fix some typos in "Scopes and ribs" 2023-06-13 19:45:19 +02:00
clubby789 c07f051fa5 Add note about shell completion scripts 2023-05-17 21:44:05 -05:00
jyn 1c106b7841 filter out S-blocked issues in the "Getting Started" search (#1687) 2023-05-15 05:24:31 +09:00
Ben Kimock 6917c2ee91 Rename InstCombine to InstSimplify (#1684) 2023-05-11 18:59:47 +09:00
Yukang 0296ecfd1f Use unpretty for debugging Hir (#1685) 2023-05-11 18:59:23 +09:00
Eric Huss 0cae602e50 Add unset-exec-env compiletest header.
This header was added in https://github.com/rust-lang/rust/pull/110644/.
2023-05-02 04:20:21 +02:00
lcnr beecd1cf3b typo 2023-04-26 12:09:10 -07:00
lcnr b9da0a0797 extend the sixth requirement 2023-04-26 12:09:10 -07:00
Lukas Wirth a641ce4bda Add docs for compare-output-lines-by-subset flag (#1677) 2023-04-22 20:50:11 +09:00
Tshepang Mbambo 91bfe51078 fix typo (#1674) 2023-04-22 20:49:13 +09:00
Brian Kung b8cf5aaaa0 Fix links in how-to-build-and-run.md (#1679) 2023-04-22 20:48:44 +09:00
Ezra Shaw 4a5e46f8ab docs: document new `suggest-tests` tool 2023-04-16 13:56:19 +02:00
Ohad Ravid a4ea4aa4a1 Fix extra slash 2023-04-16 13:30:24 +02:00
Tshepang Mbambo 414d4c8ce2 fix markup (#1670) 2023-04-10 23:23:05 +09:00
Joshua Nelson d2ec8cd362 Link to governance page
It has links to the specific channel/stream for each team.
2023-04-09 22:38:15 +02:00
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