Skip to content

Commit 1570240

Browse files
committed
compiler: cross-team collaboration
Add procedures for other teams who would like to raise issues for the compiler team to fix. Signed-off-by: David Wood <[email protected]>
1 parent 2890b72 commit 1570240

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- [Compiler](./compiler/README.md)
1717
- [Cross Compilation](./compiler/cross-compilation/README.md)
1818
- [Windows](./compiler/cross-compilation/windows.md)
19+
- [Cross-team Collaboration](./compiler/cross-team-collaboration.md)
1920
- [Review policies](./compiler/reviews.md)
2021
- [So you want to add a new option to rustc?](./compiler/new_option.md)
2122
- [Major Change Proposals](./compiler/mcp.md)
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Cross-team Collaboration
2+
If you are a member of another team and would like to raise an issue with the
3+
compiler team..
4+
5+
## ..for discussion
6+
Write a comment on a GitHub issue describing the reason for the nomination
7+
(i.e. what decision needs to be made/what opinion is sought; what are the
8+
relevant parts to the compiler team, etc) and add the `I-compiler-nominated`
9+
label to a issue (you can include `@rustbot label +I-compiler-nominated` in
10+
your comment to do this).
11+
12+
Once nominated, the issue will be discussed in a upcoming [triage
13+
meeting](./triage-meeting.html). The compiler team doesn't always get through
14+
all nominated issues each week, so it can take more than one meeting for your
15+
issue to be discussed.
16+
17+
Once discussed, a member of the team will comment on the issue with the
18+
conclusion of the discussion and linking to the relevant Zulip chat.
19+
20+
## ..to be fixed
21+
If there is an existing working relationship between a member of the requesting
22+
team and a contributor to the compiler, then the first option that a team has
23+
for requesting tasks be completed is to ping that contributor and ask if they
24+
can complete the task. It is recommended that pings take place in public Zulip
25+
channels so that..
26+
27+
- ..other contributors that have free time have the opportunity to
28+
offer their help.
29+
- ..other compiler team members/leadership can ensure that requests being made
30+
are reasonable (see the rest of this section for the types of issues that the
31+
compiler team commits to prioritizing on behalf of other teams).
32+
33+
It is worth considering the available bandwidth of the contributor that the
34+
request is being made of, and whether their areas of expertise in the compiler
35+
are relevant.
36+
37+
When there is not a appropriate contact in the compiler team to reach out to
38+
directly, write a comment on a GitHub issue (or create an issue) describing the
39+
task that needs completed. Teams should nominate issues for the compiler team
40+
when issues..
41+
42+
- ..are not already tracked by/part of an existing initiative or working group
43+
and..
44+
- ..are blocking/impeding the work of the other team (e.g. a feature or bug
45+
preventing the stabilization of something otherwise complete), but..
46+
- ..aren't absolutely mission-critical - a soundness bug or otherwise critical
47+
issue will be prioritized by the [prioritization working
48+
group](./prioritization.html) and addressed through the compiler team's other
49+
processes for these bugs. If the issue lacks a prioritization label, you can
50+
add the `I-prioritize` label and it will be enqueued for prioritization.
51+
52+
A detailed description of the feature being requested or the bug to be fixed is
53+
helpful wherever possible (so that the compiler contributor does not need to
54+
make a guess as to a solution that would solve the problem for the requesting
55+
team). If a member of the requesting team isn't explicitly listed as the
56+
point-of-contact for the issue, then the author of the comment will be assumed
57+
to be the point-of-contact.
58+
59+
Add the `I-compiler-nominated` label to a issue (you can use `@rustbot label
60+
+I-compiler-nominated` to do this).
61+
62+
Once nominated, the issue will be discussed in a upcoming [triage
63+
meeting](./triage-meeting.html). The compiler team doesn't always get through
64+
all nominated issues each week, so it can take more than one meeting for your
65+
issue to be discussed. In the compiler team's discussion, the issue may..
66+
67+
- ..be accepted, in which case it will be assigned to a contributor and the
68+
nomination label removed. Once assigned, a member of the team will work on
69+
the issue. If no work is completed after a reasonable time, then re-nominate
70+
the issue and the compiler team will find someone else to complete the work.
71+
- ..or not accepted (e.g. due to insufficient bandwidth, other
72+
critical/high-priority bugs, being unable to find an appropriate contributor,
73+
or the issue lacking feasibility). In this case, the compiler team will reply
74+
to the nomination with an explanation and will remove the nomination label.

0 commit comments

Comments
 (0)