From 415b72fdc36069c9a9be10605bb4def87f094f36 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Tue, 23 Sep 2025 21:46:42 +0200 Subject: [PATCH 1/3] a consistent casing --- src/wg-rustc-dev-guide/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/wg-rustc-dev-guide/index.md b/src/wg-rustc-dev-guide/index.md index b4465a09..bd55d966 100644 --- a/src/wg-rustc-dev-guide/index.md +++ b/src/wg-rustc-dev-guide/index.md @@ -9,7 +9,7 @@ as: - Reviewing simple PRs to the guide that don't need domain-specific expertise - Connect domain-specific doc changes with domain expert reviewers -## Review Policy +## Review policy The dev guide has a much lower bar for changes to merged compared to the compiler itself. Incomplete and/or WIP documentation is preferred over no documentation. Stubbed out TODOs with issues tracking @@ -36,7 +36,7 @@ There are some benefits following this rule: - Changes to `rustc-dev-guide` repo do not need to go through bors CI in `rust-lang/rust`. - Less burden on bors queue in `rust-lang/rust`. -## Subtree Syncs +## Subtree syncs The dev guide is a [josh](https://josh-project.github.io/josh/intro.html) subtree of the main rust-lang/rust repo. This makes it easier for compiler contributors to update documentation in the dev guide in tandem with From a01840e34ce2263829db3ec6adf8a602d7486359 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Tue, 23 Sep 2025 21:47:29 +0200 Subject: [PATCH 2/3] rdg: talk membership Also, syncing with rust-lang/rust is not the most needful of responsibilities, so place it last. --- src/wg-rustc-dev-guide/index.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/src/wg-rustc-dev-guide/index.md b/src/wg-rustc-dev-guide/index.md index bd55d966..b23807b1 100644 --- a/src/wg-rustc-dev-guide/index.md +++ b/src/wg-rustc-dev-guide/index.md @@ -1,13 +1,37 @@ # rustc-dev-guide -The rustc-dev-guide working group is responsible for maintaining the rustc-dev-guide (located at -[rust-lang/rustc-dev-guide]). This includes things such -as: -- Performing subtree syncs between the main rust repo and the rustc-dev-guide repo +The rustc-dev-guide team, a sub-team of the [compiler team](../compiler/index.md), +is responsible for maintaining the rustc-dev-guide (located at [rust-lang/rustc-dev-guide]). + +## Team responsibilities + - Triaging the state of the guide to look for out of date information or missing information - Miscellaneous editorial work of the pages in the guide or fixing links that have bitrot - Reviewing simple PRs to the guide that don't need domain-specific expertise - Connect domain-specific doc changes with domain expert reviewers +- Performing subtree syncs between the main rust repo and the rustc-dev-guide repo + +## Team membership + +- After sustained contributions, someone can be invited to join the team by a team lead. + + Note that this requirement does not apply to those who are already members of the [compiler team](../compiler/index.md), + because they implicitly own the content of the guide, + as [they are able to merge their own changes](#review-policy). + For them, membership is more a signal of an intention of + [showing some extra loving](#team-responsibilities) for the guide. + Note also that being a compiler team member implies that this requirement is already fulfilled, + as shown in [Compiler team member](../compiler/membership.md#compiler-team-member). + +- Being inactive for 6 months will result in member be placed in alumni + - It is cordial to communicate this first before doing so + +## Team leadership + +- Leads approve new members + - There should not be objections by any member +- Leads can approve subtree syncs on main rust repo +- Becoming a team lead is ad-hoc and happens on invitation ## Review policy From e2a5ee2f8e2f03c7bca78bc8e5c4f32a06205738 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Tue, 23 Sep 2025 21:50:47 +0200 Subject: [PATCH 3/3] now a team --- src/SUMMARY.md | 2 +- src/{wg-rustc-dev-guide => rustc-dev-guide}/index.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename src/{wg-rustc-dev-guide => rustc-dev-guide}/index.md (100%) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 1f5df0ec..2acc324c 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -68,7 +68,7 @@ - [Third-party and Out-of-tree Crates Policy](./compiler/third-party-out-of-tree.md) - [Triage and Prioritization](./compiler/prioritization.md) - [Working Areas](./compiler/working-areas.md) -- [rustc-dev-guide](./wg-rustc-dev-guide/index.md) +- [rustc-dev-guide](./rustc-dev-guide/index.md) - [crates.io](./crates-io/index.md) - [Crate removal](./crates-io/crate-removal.md) - [Database maintenance](./crates-io/db-maintenance.md) diff --git a/src/wg-rustc-dev-guide/index.md b/src/rustc-dev-guide/index.md similarity index 100% rename from src/wg-rustc-dev-guide/index.md rename to src/rustc-dev-guide/index.md