Skip to content

Commit 718483f

Browse files
Clarify rustdoc team roles
Add more information about review policy Fix typos and links
1 parent 9397f43 commit 718483f

File tree

5 files changed

+22
-15
lines changed

5 files changed

+22
-15
lines changed

src/rustdoc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ and considering the stabilization of rustdoc features.
44

55
We use the Forge to document the team's processes, policies and working practices, if you'd like to
66
read about how the compiler and rustdoc work and instructions on how to set up a development environment,
7-
you're looking for the [rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/).
7+
you're looking for the [rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/rustdoc.html).
88

99
- [Calendar](./calendar.md)
1010
- *How do I subscribe to the compiler team's calendar?*

src/rustdoc/membership.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Being promoted to member implies a number of privileges:
4545

4646
It also implies some obligations (in some cases, optional obligations):
4747

48+
- Members are expected to respond to FCPs in maximum 4 weeks (28 days).
4849
- Members may take part in various other [maintainer activities] to help the team.
4950
- Members are held to a higher standard than ordinary folk when it comes to the [Code of
5051
Conduct][CoC].
@@ -71,15 +72,17 @@ we have three main areas:
7172
- Internals: The internals of rustdoc: interacting with the compiler, doctests, generating
7273
rustdoc internal code representation, parsing command line arguments, lints, etc.
7374

74-
These groups are NOT full-fledge teams, and as such, to be part of any of these groups, you need to
75+
These groups are NOT full-fledged teams, and as such, to be part of any of these groups, you need to
7576
be a member of the rustdoc team.
7677

7778
For now, only the front-end group has an official status in the
7879
[team repository](https://github.com/rust-lang/team) and is called `rustdoc-frontend`. If a rustdoc
7980
team member is interested to be part of this group, they can ask to be added into it.
8081

81-
Being part of the front-end group doesn't change your rustdoc team membership. However
82-
you will be assigned for reviews on front-end pull requests and on front-end FCPs.
82+
Let's take the front-end group as an example. It is a part of the rustdoc team, so you need to be a
83+
member of the rustdoc team to be able to join this group. Being part of the front-end group means
84+
you are encouraged to be part of the review rotations for front-end pull requests and you will need
85+
to respond on front-end FCPs.
8386

8487
## How promotion decisions are made
8588
[hdam]: #how-promotion-decisions-are-made

src/rustdoc/proposals-and-stabilization.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ There are two mechanisms that the team can use to approve a proposal (not all ap
99
are suitable for each method of making a proposal - see below):
1010

1111
- r+
12-
- A proposal is r+'d when it is approved to be merged.
12+
- A proposal (an RFC or an FCP) is r+'d when it is approved to be merged.
1313
- r+ can only be used to approve a PR.
1414
- FCP
15-
- A final comment period will require sign-off from a majority of the rustdoc team to approve
16-
a proposal and then a ten day waiting period.
15+
- A final comment period will require sign-off from a majority (all members minus 2)
16+
of the rustdoc team to approve a proposal and then a ten day waiting period.
1717
- FCPs can be used to approve any form of proposal.
1818

1919
## Proposals
@@ -33,7 +33,8 @@ the nature of the proposal, described below.
3333
proposal mechanism, suitable for most proposals. PRs are preferred when the proposal is
3434
accompanied by a small patchset (such as stabilization of a compiler flag or addition of
3535
a new target).
36-
- PR proposals can be approved by *FCPs* or *r+*.
36+
- PR proposals can be approved by *FCPs* or *r+*. See *When are FCPs/RFCs required?*
37+
section below when *r+* isn't sufficient alone.
3738

3839
[rustdoc zulip thread]: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc
3940

@@ -43,8 +44,8 @@ An FCP will be needed for any stabilization of small user-facing changes, like U
4344
command-line arguments, new attributes, etc. However, if the change is considered too big/important,
4445
an RFC will need to be written and approved before the change will be accepted.
4546

46-
When opening an FCP, make sure only the relevant subteam is labeled on the issue, to avoid pinging
47-
people with changes they aren't interested in.
47+
When starting an FCP, make sure only the relevant subteam is labeled on the issue/PR, to avoid
48+
pinging people with changes they aren't interested in.
4849

4950
### What happens if someone makes a contribution that requires an approval and doesn't have one?
5051
If the approval required for the contribution requires an RFC, then the contribution
@@ -69,10 +70,6 @@ A good proposal will address the following:
6970
* **Alternatives, concerns, and key decisions:** Were there any alternatives considered? If so, why
7071
did you pick this design?
7172

72-
## What proposal/approval do I need?
73-
This section aims to exhaustively detail which proposal and approval is necessary for any given
74-
circumstance.
75-
7673
[rfcs]: https://github.com/rust-lang/rfcs
7774
[Haddock]: https://haskell-haddock.readthedocs.io/latest/
7875
[Wikipedia]: https://www.wikipedia.org/

src/rustdoc/resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ There are various resources which are useful to contributors and team members.
1111
If there are additional resources which would be useful to a contributor or compiler team member,
1212
feel free to submit a PR to add it here.
1313

14-
[dev_guide]: https://rustc-dev-guide.rust-lang.org/
14+
[dev_guide]: https://rustc-dev-guide.rust-lang.org/rustdoc.html
1515
[rustc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/index.html
1616
[rustdoc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc/index.html

src/rustdoc/reviews.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,10 @@
22

33
The rustdoc team follows the same review policy as the compiler team. Take a look at
44
[their chapter](../compiler/reviews.md) about it.
5+
6+
In addition, it's important to note that:
7+
* Anyone is welcome to provide their input as code review, even if you aren't a member of the
8+
rustdoc team.
9+
* Only team members can approve pull requests for being merged.
10+
* New features are usually subject to more in depth review and might need to go through an RFC or
11+
an FCP.

0 commit comments

Comments
 (0)