Skip to content

Commit c9556d8

Browse files
committed
[WIP] Tweak T-rustdoc processes docs
1 parent 7481038 commit c9556d8

File tree

1 file changed

+32
-12
lines changed

1 file changed

+32
-12
lines changed

src/rustdoc/proposals-and-stabilization.md

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,54 @@ decisions and when each should be used.
66

77
## Approvals
88
There are two mechanisms that the team can use to approve a proposal (not all approval mechanisms
9-
are suitable for each method of making a proposal - see below):
9+
are suitable for each method of making a proposal - [see below](#proposals)):
1010

11-
- r+
12-
- A proposal (an RFC or an FCP) is r+'d when it is approved to be merged.
11+
- [*r+*]
12+
- A proposal is *r+*'d when it is approved to be merged.
1313
- r+ can only be used to approve a PR.
14+
- <!-- FIXME(fmease): *somewhere* I want to clarify *who* is in charge of the r+
15+
(namely any team member(s) but usually PR assignee(s)) -->
1416
- FCP
1517
- A final comment period will require sign-off from a majority (all members minus 2)
1618
of the rustdoc team to approve a proposal and then a ten day waiting period.
1719
- FCPs can be used to approve any form of proposal.
20+
- <!-- FIXME(fmease): Somewhere I want to clarify that after an FCP, in r-l/r
21+
a separate r+ is still necessary by someone / a GH approval in other repos;
22+
also I want to mention somewhere that any team is allowed to merge an FCP'ed RFC -->
23+
24+
[*r+*]: ../compiler/reviews.html#bors
1825

1926
## Proposals
20-
There are three ways to propose a change to the rustdoc team. The appropriate choice depends on
27+
There are four ways to propose a change to the rustdoc team. The appropriate choice depends on
2128
the nature of the proposal, described below.
2229

23-
- Open a discussion on the [rustdoc zulip thread].
30+
- Open a discussion in the [rustdoc Zulip channel].
2431
- This is the preferred way. It allows to prevent users to lose too much time implementing
2532
something if in the end, the team will ask major changes or even refuse it. After the
2633
discussion, if accepted and depending on the change, an RFC or a PR will be the next step.
34+
- <!-- FIXME(fmease): Clarify what "approval" means. Namely the approvals are casual,
35+
"non-binding". >=1 endorsements is fine/usual -->
2736
- Request For Comments (RFC)
28-
- RFCs are pull requests to the [`rust-lang/rfcs`][rfcs] repository and are a heavy-weight
37+
- RFCs are pull requests to the [`rust-lang/rfcs`] repository and are a heavy-weight
2938
proposal mechanism, reserved for significant changes.
3039
- RFC proposals can only be approved by *FCPs*.
40+
- <!-- FIXME(fmease): Or mention the "r+ after FCP" topic from above here instead -->
3141
- Pull Request (PR)
32-
- Opening a pull request on the [`rust-lang/rust`][rust] repository is a lightweight
42+
- Opening a pull request on the [`rust-lang/rust`] repository is a lightweight
3343
mechanism suitable for most proposals. This is preferred in cases such as stabilization
3444
of a rustdoc flag or addition of a new target.
3545
- PR proposals can be approved by *FCPs* or *r+*. See *When are FCPs/RFCs required?*
3646
section below when *r+* isn't sufficient alone.
3747
- Issues
38-
- Opening an issue on the [`rust-lang/rust`][rust] repository are also a good starting
48+
- Opening an issue in the [`rust-lang/rust`] repository is also a good starting
3949
point if you don't know which of the previous ways is the best fit.
50+
- <!-- FIXME(fmease): Clarify that there's no process for approvals for
51+
GH issues; moreover mention that we usually don't FCP issue proposals but
52+
instead the corresponding PR -->
4053

41-
[rustdoc zulip thread]: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc
42-
[rust]: https://github.com/rust-lang/rust
54+
[rustdoc Zulip channel]: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc
55+
[`rust-lang/rust`]: https://github.com/rust-lang/rust
56+
[`rust-lang/rfcs`]: https://github.com/rust-lang/rfcs
4357

4458
### When are FCPs/RFCs required?
4559

@@ -48,6 +62,9 @@ the GUI web interface, new command-line arguments, new attributes, etc. However,
4862
is considered too big/important, an RFC will need to be written and approved before the change
4963
will be accepted.
5064

65+
<!-- FIXME(fmease): ^^^ Tweak phrasing. The stabilization of an already-RFC'ed feature
66+
always(?) requires an FCP (and doesn't need another RFC :P) -->
67+
5168
When starting an FCP, make sure only the relevant subteam is labeled on the issue/PR, to avoid
5269
pinging people with changes they aren't interested in.
5370

@@ -56,11 +73,15 @@ If the approval required for the contribution requires an RFC, then the contribu
5673
should be closed or marked as blocked, with a request to create an RFC first. If approval of
5774
a PR is acceptable for the specific contribution (see below), then the approval process can begin.
5875

59-
### Can I work on code experimentally before a approval is gained?
76+
<!-- FIXME: Mention S-blocked -->
77+
78+
### Can I work on code experimentally before an approval is gained?
6079
Of course! You are free to work on PRs or write code. But those PRs should be marked as
6180
experimental and they should not land, nor should anyone be expected to review them (unless
6281
folks want to).
6382

83+
<!-- FIXME: Mention S-experimental -->
84+
6485
## What makes a good proposal?
6586
A good proposal will address the following:
6687

@@ -74,7 +95,6 @@ A good proposal will address the following:
7495
* **Alternatives, concerns, and key decisions:** Were there any alternatives considered? If so, why
7596
did you pick this design?
7697

77-
[rfcs]: https://github.com/rust-lang/rfcs
7898
[Haddock]: https://haskell-haddock.readthedocs.io/latest/
7999
[Wikipedia]: https://www.wikipedia.org/
80100
[Racket]: https://docs.racket-lang.org/

0 commit comments

Comments
 (0)