Skip to content

Commit 4ef58f2

Browse files
committed
Explain where rdg changes should be submitted
Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn>
1 parent 3008550 commit 4ef58f2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/contributing.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,16 @@ Just a few things to keep in mind:
434434
it might benefit from having a Table of Contents at the beginning,
435435
which you can auto-generate by including the `<!-- toc -->` marker at the top.
436436

437+
#### ⚠️ Note: Where to contribute `rustc-dev-guide` changes
438+
439+
If your change **only involves the documentation content of rustc-dev-guide** and **does not accompany `rust-lang/rust` code changes**,
440+
please submit your changes and PRs directly to the [rust-lang/rustc-dev-guide](https://github.com/rust-lang/rustc-dev-guide) repository.
441+
442+
There are some benifits following this rule:
443+
- Changes to `rustc-dev-guide` repo can be immediately reflected in [the live rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/).
444+
- Changes to `rustc-dev-guide` repo do not need to go through bors CI in `rust-lang/rust`.
445+
- Less burden on bors queue in `rust-lang/rust`.
446+
437447
## Issue triage
438448

439449
Please see <https://forge.rust-lang.org/release/issue-triaging.html>.

0 commit comments

Comments
 (0)