1
1
# rustc-dev-guide
2
2
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
+
7
8
- Triaging the state of the guide to look for out of date information or missing information
8
9
- Miscellaneous editorial work of the pages in the guide or fixing links that have bitrot
9
10
- Reviewing simple PRs to the guide that don't need domain-specific expertise
10
11
- 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
11
35
12
- ## Review Policy
36
+ ## Review policy
13
37
14
38
The dev guide has a much lower bar for changes to merged compared to the compiler itself. Incomplete
15
39
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:
36
60
- Changes to ` rustc-dev-guide ` repo do not need to go through bors CI in ` rust-lang/rust ` .
37
61
- Less burden on bors queue in ` rust-lang/rust ` .
38
62
39
- ## Subtree Syncs
63
+ ## Subtree syncs
40
64
41
65
The dev guide is a [ josh] ( https://josh-project.github.io/josh/intro.html ) subtree of the main rust-lang/rust
42
66
repo. This makes it easier for compiler contributors to update documentation in the dev guide in tandem with
0 commit comments