Commit Graph

94 Commits

Author SHA1 Message Date
许杰友 Jieyou Xu (Joe) 32835d18d8 Only keep label description in Forge docs 2025-01-06 18:59:36 +02:00
DianQK 168301374d Describe how to revert a PR (#2118)
Co-authored-by: Jieyou Xu <jieyouxu@outlook.com>
2024-11-03 14:32:15 +08:00
许杰友 Jieyou Xu (Joe) 8d9a7a8b13 Add advice about submitting potentially hard-to-review PRs (#2036) 2024-09-23 16:46:49 +08:00
Tshepang Mbambo a8f2415953 fix/improve rdg contributing howto (#2056) 2024-09-09 00:13:14 +08:00
许杰友 Jieyou Xu (Joe) 34b055b8f8 Link to lint L-* labels 2024-05-13 20:09:18 +02:00
Nilstrieb 023c0f2592 Delete length check (#1952)
It's super annoying to be forced to use this bad convention, and
apparently everyone agrees. The only reason no improvements have been
done is because those were blocked on writing a better checker.

I strongly believe that no checker is better than a bad checker, so
let's just delete it in the meantime. I kindly asked anyone who sees
this to complain about overly long sentences in review in the future, I
think we can make this turn out fine.
2024-03-30 17:46:30 +01:00
Yukang b99b876c15 Add some explanations for frequently used rustbot commands (#1849)
* add some explain for rustbot commands

* add more details about shortcuts

* fix words on `r=someone`

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

---------

Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2024-01-20 19:56:35 +08:00
León Orell Valerian Liehr 4083ae0309 Add guidelines for backport-accepted PRs 2024-01-14 11:42:53 +01:00
León Orell Valerian Liehr 034cee9ed6 Mention label has-merge-commits 2024-01-14 11:42:53 +01:00
Tshepang Mbambo fd0505a41c various fixes/improvements to Contributing chapter (#1723) 2023-07-08 11:52:53 +09:00
sslime336 a04ad82e3c Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
Eric Huss 1b6f93987d Fix some links 2023-06-29 06:43:19 +02:00
Tshepang Mbambo 414d4c8ce2 fix markup (#1670) 2023-04-10 23:23:05 +09: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 a5f0310ba4 Fix link; remove duplicate link 2023-04-09 22:38:15 +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
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
Eric Huss ccef9cb8e1 Update labels overview (#1639) 2023-03-21 18:07:36 +09:00
Thom Chiovoloni 31991ba0cb Rename `config.toml.example` to `config.example.toml` 2023-03-13 04:42:00 +02:00
Tshepang Mbambo cee03b4dc3 improve capacity note (#1634) 2023-03-06 22:08:37 +09:00
apiraino 6b2d30b2e5 Add detail to contributing guide (#1628) 2023-03-03 20:14:53 +09:00
Michele 4308463e70 Typo 2023-02-16 07:26:00 +02:00
Michele 51aaeee90d Typo 2023-02-16 07:24:32 +02:00
Tshepang Mbambo 710cc3eb66 bumpt date-check examples to current month (#1566) 2023-01-27 07:51:28 +09:00
Joshua Nelson bd26e3aae5 Replace `$TARGET` with `host`
This avoids having to manually modify the configuration in the docs.
2022-12-31 18:23:52 -06:00
Tshepang Mbambo 57f1ba022b share same link 2022-12-08 19:02:08 -08:00
Yuki Okushi 48d78e345c fix: Fix broken links
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-12-09 03:13:38 +02:00
Ralf Jung ce5a4c75c0 clarify subtree tool policy (#1518) 2022-12-03 09:32:00 +09:00
Eric Huss 96c69528ad Update for highfive transition. 2022-10-27 06:07:59 +02:00
Luqman Aden 3a21e559be miri is no longer a submodule but a subtree. (#1488) 2022-10-23 08:17:08 +09:00
Eric Huss 4123cb2cd9 Update for removal of RLS (#1450) 2022-09-02 23:03:15 +09:00
Tshepang Mbambo 8194045511 make date-check more lightweight (#1394)
* make date-check lightweight

This avoids having to write the date twice when updating date-check.

Before "As of <-- 2022-07 --> July 2022"
After "As of July 2022"

* please clippy

* update date-check docs

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042163557

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#pullrequestreview-1042167261

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#issuecomment-1189105017

* this breaks markdown

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018268

This led to a more robust regex, though making the tool more picky.
It also found a wrong date format that was missed.

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018419

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018816

* accept review suggestion

This was reverted by mistake

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934019395

* use a more simple fn

* address review comment

https://github.com/rust-lang/rustc-dev-guide/pull/1394#discussion_r934018981

Much more clean

* nit

* accept review suggestion

Co-authored-by: Noah Lev <camelidcamel@gmail.com>

* avoid a failed regex

Also, test new shape

* adjust to new regex (which uses named groups)

New regex was introduced by 456008cc35

Co-authored-by: Noah Lev <camelidcamel@gmail.com>
2022-08-02 13:50:32 -07:00
Amos Wenger 8d227efda1 rust-analyzer is now a subtree
It used to be a submodule.

cf. https://github.com/rust-lang/rust/pull/99603
2022-07-25 11:40:28 +02:00
Amos Wenger 0e30f7c0bf Link to rendered book directly
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
2022-07-19 15:58:55 +02:00
Amos Wenger 386fc96942 Fix link to clippy sync docs 2022-07-19 15:58:55 +02:00
Yuki Okushi b6e4058122 Remove a mention to Steve on r? example
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
2022-07-18 07:31:14 +02:00
Tshepang Mbambo 061577567f use relative links
Used the following command, followed by some manual tweaking:

  sd 'https://rustc-dev-guide.rust-lang.org/(.+).html' '$1.md' (fd)
2022-07-17 02:32:44 +02:00
Joshua Nelson d7ead280b4 Update the build instructions for the standard library
Since https://github.com/rust-lang/rust/pull/95503, `library/std` means
"build just std and its dependencies"; to get the old behavior that built
`proc_macro` and `test`, you need `x build library`.

- Update `library/std` to `library`
- Remove the `-i` suggestions; `incremental = true` is already the default for most profiles, in
  which case `-i` does nothing. If you don't have incremental enabled, I still think suggesting `-i`
  is bad idea, because it's easy to forget once, at which point you'll end up rebuilding the whole
  compiler / standard library.
- Remove a few repetitive sections and don't discuss incremental in such detail
  Incremental works well enough that it should "just work" for most people;
  I don't think it needs multiple paragraphs of explanation so early in the guide.
- Clarify that `test library/std` *only* tests libstd in a few places
2022-07-11 07:22:24 +02:00
Yuki Okushi 6ec2a84d4d Update some links and docs (#1340) 2022-05-17 07:54:45 +09:00
Yuki Okushi a1340e010c Update some date refs 2022-04-20 13:09:19 -07:00
Ivor Wanders 638d7fb6ab Clarify that r? works in comments. 2022-01-20 18:01:07 -08:00
Georgiy Komarov e3da6331dd Spelling: Rename `rust` to `Rust` (#1288) 2022-01-18 11:09:37 -03:00
Ben Reeves 440503e38d Fix link in contributing.md (#1280) 2021-12-27 10:28:15 -06:00
Lucas Kent 08bc5de96a Improve documentation on r? 2021-12-09 09:09:36 -06:00
Ken Matsui e1babf580d Unify `x.py` usage (#1258) 2021-11-16 07:44:50 +09:00