Skip to content

Commit ff29630

Browse files
authored
Move here remaining T-compiler docs (#814)
1 parent d9e63e0 commit ff29630

File tree

5 files changed

+72
-16
lines changed

5 files changed

+72
-16
lines changed

src/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@
5252
- [Proposals, Approval and Stabilization](./compiler/proposals-and-stabilization.md)
5353
- [Third-party and Out-of-tree Crates Policy](./compiler/third-party-out-of-tree.md)
5454
- [Triage and Prioritization](./compiler/prioritization.md)
55+
- [Operations](./compiler/operations.md)
5556
- [crates.io](./crates-io/README.md)
5657
- [Crate removal](./crates-io/crate-removal.md)
5758
- [Database maintenance](./crates-io/db-maintenance.md)

src/compiler/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@ you're looking for the [rustc-dev-guide](https://rustc-dev-guide.rust-lang.org/)
2525
the compiler?*
2626
- [Triage and Prioritization](./prioritization.md)
2727
- *How are compiler issues triaged and prioritized?*
28+
- [Operations](./operations.md)
29+
- *Supporting the compiler team*

src/compiler/meetings.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ performance triage reports and discussing nominated issues. Triage meetings are
99
[the team calendar](./calendar.md). Anyone can attend and it is recommended that compiler team
1010
members do.
1111

12+
Agendas of triage meetings are stored on [HackMD][meeting_triage_notes].
13+
1214
### Generating the triage meeting agenda
1315
See [*Prioritization*](./prioritization.md) for documentation on generating the triage meeting
1416
agenda.
@@ -19,7 +21,7 @@ discussions. Steering/planning meetings operate on a repeating schedule:
1921

2022
- **Week 1:** Planning meeting
2123
- Select the topics for the next three meetings from the team's proposed meetings.
22-
- **Week 2-4:** Steering meeting
24+
- **Week 2-4:** Steering meeting
2325
- Discuss the planned topic.
2426

2527
During planning meetings, the team lead running the meeting will attempt to identify topics which
@@ -52,5 +54,9 @@ Any contributor can propose a meeting topic. Some examples of good steering meet
5254
Scheduled planning and steering meetings can be found on the [compiler team's
5355
calendar](./calendar.md).
5456

57+
Minutes of steering meetings are stored on [HackMD][meeting_steering_notes].
58+
5559
[team_repo]: https://github.com/rust-lang/compiler-team
5660
[meetings_channel]: https://rust-lang.zulipchat.com/#narrow/channel/238009-t-compiler.2Fmeetings
61+
[meeting_steering_notes]: https://hackmd.io/team/rust-compiler-team?nav=overview&tags=%5B%22steering%22%5D&tagtree-filter=true
62+
[meeting_triage_notes]: https://hackmd.io/team/rust-compiler-team?nav=overview&tags=%5B%22weekly%22%5D&tagtree-filter=true

src/compiler/operations.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Operations
2+
3+
Here is a list of recurring tasks to support the compiler team and help keep things moving forward. Ideally run through this list every week. If there are blockers or doubts, after having acquired the right context, don't hesitate to ping people around. Keep in mind that contributors are the best resource of the project and we want to be mindful of their time.
4+
5+
## Issues hygiene
6+
7+
- [Issue to be prioritized](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-prioritize): see [prioritization](https://forge.rust-lang.org/compiler/prioritization.html).
8+
- [P-high issues without assignee](https://github.com/rust-lang/rust/issues?q=is%3Aopen+label%3AT-compiler+label%3AP-high+no%3Aassignee): ideally this category of issues should have an assignee (filter out those without a PR).In rare cases it's fine if they don't.
9+
- [MCP in FCP status](https://github.com/rust-lang/compiler-team/issues?q=is%3Aissue+is%3Aopen+label%3Afinal-comment-period+sort%3Acreated-asc), close seconded since more 10 days, ensure no open concerns
10+
- [Check open MCPs](https://github.com/rust-lang/compiler-team/issues?q=is%3Aissue+is%3Aopen+label%3Amajor-change+-label%3Afinal-comment-period+sort%3Aupdated-asc): [MCP is a protocol](https://forge.rust-lang.org/compiler/proposals-and-stabilization.html) to bring proposals to the compiler team attention. Ensure MCPs are moving towards one of these two outcome, being seconded or being closed for lack of seconding. When it's clear that an MCP won't be seconded or is abandoned, after about two or three months is ok to query its status and evaluate closing it. Otherwise try to get them unstuck.
11+
- [Issues needing a reproducible](https://github.com/rust-lang/rust/issues?q=is%3Aopen+label%3AE-needs-mcve+label%3AT-compiler+sort%3Acreated-asc)
12+
- [Issues and PRs that are going through FCP](https://github.com/rust-lang/rust/issues?q=sort%3Aupdated-desc+label%3Afinished-final-comment-period): check if the team need to check their box. These issues are in the weekly triage agenda.
13+
14+
## Prioritization for T-compiler
15+
16+
Some useful filters when looking at regressions.
17+
18+
- [Nightly regressions without priority](https://github.com/rust-lang/rust/issues?q=is%3Aissue+label%3AT-compiler+label%3Aregression-from-stable-to-nightly+-label%3AI-prioritize++is%3Aopen)
19+
- [Beta regressions without priority](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AT-compiler+label%3Aregression-from-stable-to-beta+-label%3AI-prioritize)
20+
- [Stable regressions without priority](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AT-compiler+label%3Aregression-from-stable-to-stable+-label%3AI-prioritize)
21+
- [Untriaged regressions without a priority](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AT-compiler+label%3Aregression-untriaged+-label%3AP-critical+-label%3AP-high+-label%3AP-medium+-label%3AP-low+-label%3AI-prioritize)
22+
23+
## PRs hygiene
24+
25+
- Every PR should have a team assigned
26+
- [PR without a team label](https://github.com/rust-lang/rust/pulls?q=is%3Apr+is%3Aopen+draft%3Afalse+-label%3AT-libs-api+-label%3AT-libs+-label%3AT-rustdoc+-label%3AT-compiler+-label%3AT-lang+-label%3AT-infra+-label%3AT-release+-label%3AT-types+-label%3AT-style+-label%3AT-bootstrap+-label%3AT-opsem+sort%3Acreated-asc)
27+
- [Waiting on author](https://github.com/rust-lang/rust/pulls?q=is%3Apr+is%3Aopen+draft%3Afalse+-label%3AT-libs-api+-label%3AT-libs+-label%3AT-rustdoc+-label%3AT-compiler+-label%3AT-lang+-label%3AT-infra+-label%3AT-release+-label%3AT-types+-label%3AT-style+-label%3AT-bootstrap+label%3AS-waiting-on-author+sort%3Aupdated-asc)
28+
- [Waiting on a review](https://github.com/rust-lang/rust/pulls?q=is%3Apr+is%3Aopen+draft%3Afalse+-label%3AT-libs-api+-label%3AT-libs+-label%3AT-rustdoc+-label%3AT-compiler+-label%3AT-lang+-label%3AT-infra+-label%3AT-release+-label%3AT-types+-label%3AT-style+-label%3AT-bootstrap+label%3AS-waiting-on-review+sort%3Aupdated-asc)
29+
30+
## Things to do a week before the release:
31+
32+
- [No regression without priority](https://github.com/rust-lang/compiler-team/issues?q=is%3Aissue+is%3Aopen+label%3Afinal-comment-period+sort%3Acreated-asc): ensure they've been fixed and if not try to get the team attention.
33+
- No [beta regressions](https://github.com/rust-lang/compiler-team/issues?q=is%3Aissue+is%3Aopen+label%3Afinal-comment-period+sort%3Acreated-asc) or [stable regressions](https://github.com/rust-lang/compiler-team/issues?q=is%3Aissue+is%3Aopen+label%3Afinal-comment-period+sort%3Acreated-asc) regressions without an owner, filter out those out without a PR.
34+
- No [beta regressions](https://github.com/rust-lang/rust/issues?q=label%3Aregression-from-stable-to-beta+label%3AT-compiler+is%3Aopen) or [stable regressions](https://github.com/rust-lang/rust/issues?q=label%3Aregression-from-stable-to-stable+label%3AT-compiler+is%3Aopen) regressions work in progress, ideally they should all be merged.
35+
- Ensure breaking changes (i.e. regressions agreed to be acceptable) has a corresponding issue tagged `relnotes-tracking-issue`, see [list of release notes](https://github.com/rust-lang/rust/issues?q=sort%3Aupdated-desc+is%3Aopen+label%3Arelnotes-tracking-issue). T-release will then pick them up and add them to the release notes.
36+
37+
## After the release
38+
39+
- Check which regressions can be closed as "accepted". Add a comment clarifying that the PR causing the regression is accepted as breaking change, example: "Closing since PR #123456 will be mentioned in the release notes". Check carefully, don't be trigger-happy. Discussions and comments about this practice can be directed on [Zulip](https://rust-lang.zulipchat.com/#narrow/channel/242269-t-release.2Ftriage/topic/beta.20regressions.20that.20are.20no.20more/near/456509338).
40+
41+
## Rest of the world
42+
43+
These filters are for checking what's happening in other teams
44+
45+
- [List of open RFCs](https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3Aproposed-final-comment-period+label%3Adisposition-merge+sort%3Aupdated-asc) (all teams) waiting for the team to discuss or check the proposal, can anything be done to help moving them forward?

src/compiler/prioritization.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,12 @@ To assign a priority, replace the `I-prioritize` label with one of `P-critical`,
132132
`P-medium` or `P-low` and adding a succinct comment to link the Zulip discussion where the issue
133133
prioritization occurred, example of a template for the comment:
134134

135-
> WG-prioritization assigning priority ([Zulip discussion](#)).
135+
> Assigning priority (discussion on [Zulip](#)).
136136
>
137137
> @rustbot label -I-prioritize +P-XXX
138138
139+
Tip: use [Github Saved Replies](https://docs.github.com/get-started/writing-on-github/working-with-saved-replies) to create a template comment.
140+
139141
Ideally, all [`T-compiler` issues with a `I-prioritize` label][issues_needing_prio] to have a
140142
priority assigned, or strive to reach this goal: sometimes different factors are blocking issues
141143
from being assigned a priority label, either because the report or the context is unclear or
@@ -151,7 +153,7 @@ try to ensure they are assigned when possikle.
151153
[beta_regressions]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+label%3Aregression-from-stable-to-beta+-label%3AP-critical+-label%3AP-high+-label%3AP-medium+-label%3AP-low+-label%3AT-infra+-label%3AT-libs+-label%3AT-libs-api+-label%3AT-release+-label%3AT-rustdoc
152154
[nightly_regressions]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+label%3Aregression-from-stable-to-nightly+-label%3AP-critical+-label%3AP-high+-label%3AP-medium+-label%3AP-low+-label%3AT-infra+-label%3AT-libs+-label%3AT-libs-api+-label%3AT-release+-label%3AT-rustdoc
153155

154-
The final step prior to generating the agenda is to accept any MCPs. Any MCPs that have had [the `final-comment-period` label][mcp_fcp]
156+
The final step prior to generating the agenda is to accept any MCPs. Any MCPs that have had [the `final-comment-period` label][mcp_fcp]
155157
for more than ten days can be accepted. Remove the `final-comment-period` label and add the `major-change-accepted` label and then
156158
close the issue.
157159

@@ -176,21 +178,21 @@ Copy the content into a new HackMD in the "Rust Lang Compiler Team" space. Copy
176178
Add additional manual details to the agenda:
177179

178180
- Add summaries of stable/beta nominations (e.g. who nominated the backport and why)
179-
- Add summaries of PRs waiting on the team (i.e. why are they waiting)
181+
- Add summaries of PRs waiting on the team (i.e. why are they waiting)
180182
- Add initial impressions of `P-critical`/`P-high` bugs
181183
- Add summaries of nominated issues (e.g. who the assignee is, why it was nominated, etc)
182184
- Populate the oldest PRs waiting on review
183185
- Use judgement to determine whether a ping is appropriate (e.g. if the pull request is an
184186
experiment, it may not need a review; how long has it been since review activity; what do
185187
recent comments say?)
186188

187-
Two hours prior to the meeting, announce and share the completed agenda in the Zulip thread for the
189+
About two hours prior to the meeting, announce and share the completed agenda in the Zulip thread for the
188190
upcoming meeting (creating it if it does not already exist):
189191

190192
```text
191-
Hi @*T-compiler/meeting*; the triage meeting will happen tomorrow in about 2 hours.
192-
*WG-prioritization* has done pre-triage in #**t-compiler/wg-prioritization/alerts**
193-
@*WG-prioritization* has prepared the [meeting agenda](link_to_hackmd_agenda)
193+
Hello @*T-compiler/meeting*, triage meeting in about 2h
194+
Pre-triage done in #**t-compiler/wg-prioritization/alerts**.
195+
Meeting agenda [on HackMD](https://hackmd.io/link_to_hackmd_agenda)
194196
```
195197

196198
It is always recommended to re-run the generator and copy any new details over to the agenda as
@@ -218,12 +220,12 @@ After the meeting, there are a few closing tasks:
218220
the `I-compiler-nominated` will stick until next meeting. Create a new agenda stub for the
219221
following.
220222

221-
[beta_nominated]: https://github.com/rust-lang/rust/issues?q=is%3Aall+label%3Abeta-nominated+-label%3Abeta-accepted
222-
[stable_nominated]: https://github.com/rust-lang/rust/issues?q=is%3Aall+label%3Astable-nominated+-label%3Astable-accepted
223-
[rust_announce]: https://github.com/rust-lang/rust/issues?q=is%3Aall+label%3Afinished-final-comment-period+label%3Ato-announce
224-
[team_announce]: https://github.com/rust-lang/compiler-team/issues?q=is%3Aall+label%3Afinished-final-comment-period+label%3Ato-announce
225-
[forge_announce]: https://github.com/rust-lang/rust-forge/issues?q=is%3Aall+label%3Afinished-final-comment-period+label%3Ato-announce
226-
[fcps]: https://github.com/rust-lang/compiler-team/issues?q=is%3Aall+label%3Amajor-change+label%3Ato-announce
227-
[mcps]: https://github.com/rust-lang/compiler-team/issues?q=is%3Aall+label%3Amajor-change+label%3Ato-announce
223+
[beta_nominated]: https://github.com/rust-lang/rust/issues?q=is%3Apr+label%3Abeta-nominated+-label%3Abeta-accepted
224+
[stable_nominated]: https://github.com/rust-lang/rust/issues?q=is%3Apr+label%3Astable-nominated+-label%3Astable-accepted
225+
[rust_announce]: https://github.com/rust-lang/rust/issues?q=label%3Afinished-final-comment-period+label%3Ato-announce
226+
[team_announce]: https://github.com/rust-lang/compiler-team/issues?q=label%3Afinished-final-comment-period+label%3Ato-announce
227+
[forge_announce]: https://github.com/rust-lang/rust-forge/issues?q=label%3Afinished-final-comment-period+label%3Ato-announce
228+
[fcps]: https://github.com/rust-lang/compiler-team/issues?q=label%3Amajor-change+label%3Ato-announce
229+
[mcps]: https://github.com/rust-lang/compiler-team/issues?q=label%3Amajor-change+label%3Ato-announce
228230
[relese_backports]: ../release/backporting.md
229-
[compiler_nominated]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+label%3AI-nominated+label%3AT-compiler
231+
[compiler_nominated]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+label%3AI-compiler-nominated+label%3AT-compiler

0 commit comments

Comments
 (0)