Skip to content

Commit 1ea1deb

Browse files
authored
Merge pull request #956 from rust-lang/tshepang/rdg-charter
2 parents cf8c4d0 + e2a5ee2 commit 1ea1deb

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
- [Third-party and Out-of-tree Crates Policy](./compiler/third-party-out-of-tree.md)
6969
- [Triage and Prioritization](./compiler/prioritization.md)
7070
- [Working Areas](./compiler/working-areas.md)
71-
- [rustc-dev-guide](./wg-rustc-dev-guide/index.md)
71+
- [rustc-dev-guide](./rustc-dev-guide/index.md)
7272
- [crates.io](./crates-io/index.md)
7373
- [Crate removal](./crates-io/crate-removal.md)
7474
- [Database maintenance](./crates-io/db-maintenance.md)

src/wg-rustc-dev-guide/index.md renamed to src/rustc-dev-guide/index.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,39 @@
11
# rustc-dev-guide
22

3-
The rustc-dev-guide working group is responsible for maintaining the rustc-dev-guide (located at
4-
[rust-lang/rustc-dev-guide]). This includes things such
5-
as:
6-
- Performing subtree syncs between the main rust repo and the rustc-dev-guide repo
3+
The rustc-dev-guide team, a sub-team of the [compiler team](../compiler/index.md),
4+
is responsible for maintaining the rustc-dev-guide (located at [rust-lang/rustc-dev-guide]).
5+
6+
## Team responsibilities
7+
78
- Triaging the state of the guide to look for out of date information or missing information
89
- Miscellaneous editorial work of the pages in the guide or fixing links that have bitrot
910
- Reviewing simple PRs to the guide that don't need domain-specific expertise
1011
- Connect domain-specific doc changes with domain expert reviewers
12+
- Performing subtree syncs between the main rust repo and the rustc-dev-guide repo
13+
14+
## Team membership
15+
16+
- After sustained contributions, someone can be invited to join the team by a team lead.
17+
18+
Note that this requirement does not apply to those who are already members of the [compiler team](../compiler/index.md),
19+
because they implicitly own the content of the guide,
20+
as [they are able to merge their own changes](#review-policy).
21+
For them, membership is more a signal of an intention of
22+
[showing some extra loving](#team-responsibilities) for the guide.
23+
Note also that being a compiler team member implies that this requirement is already fulfilled,
24+
as shown in [Compiler team member](../compiler/membership.md#compiler-team-member).
25+
26+
- Being inactive for 6 months will result in member be placed in alumni
27+
- It is cordial to communicate this first before doing so
28+
29+
## Team leadership
30+
31+
- Leads approve new members
32+
- There should not be objections by any member
33+
- Leads can approve subtree syncs on main rust repo
34+
- Becoming a team lead is ad-hoc and happens on invitation
1135

12-
## Review Policy
36+
## Review policy
1337

1438
The dev guide has a much lower bar for changes to merged compared to the compiler itself. Incomplete
1539
and/or WIP documentation is preferred over no documentation. Stubbed out TODOs with issues tracking
@@ -36,7 +60,7 @@ There are some benefits following this rule:
3660
- Changes to `rustc-dev-guide` repo do not need to go through bors CI in `rust-lang/rust`.
3761
- Less burden on bors queue in `rust-lang/rust`.
3862

39-
## Subtree Syncs
63+
## Subtree syncs
4064

4165
The dev guide is a [josh](https://josh-project.github.io/josh/intro.html) subtree of the main rust-lang/rust
4266
repo. This makes it easier for compiler contributors to update documentation in the dev guide in tandem with

0 commit comments

Comments
 (0)