Skip to content

Commit 41240c5

Browse files
sethladdgemini-code-assist[bot]
authored andcommitted
Enhance issue triage guidelines in CONTRIBUTING.md (flutter#409)
* Enhance issue triage guidelines in CONTRIBUTING.md Added detailed guidelines for daily and periodic issue triage processes. * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Reformat issue triage instructions for clarity * Add link to replace the TODO --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent ec44cea commit 41240c5

File tree

1 file changed

+48
-10
lines changed

1 file changed

+48
-10
lines changed

CONTRIBUTING.md

Lines changed: 48 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,41 @@ To run a script in `tool/`, open the script in VSCode and press ⇧⌘B.
1919

2020
## Issue triage
2121

22-
We regularly triage issues by looking at newly filed issues and determining what
23-
we should do about each of them. Triage issues as follows:
22+
### Daily front-line triage
23+
24+
The function of the daily front-line triage is to determine if the issue
25+
is a _critical_ issue that needs immediate response.
26+
27+
Until the genui package is marked as 1.0,
28+
an issue is _critical_ if it blocks someone from compiling the
29+
package's code as part of their build process, or if previously
30+
advertised behavior breaks in surprising ways (a behavior change
31+
is not surprising if it was documented as part of the release
32+
of the package).
33+
We note that _critical_ issues should be very rare.
34+
35+
We have a rotation which runs daily on business days. The responsibilities
36+
of the front-line triage include:
37+
38+
* Once a day, open the list of new issues which do not have
39+
[`front-line-handled` label][for-front-line].
40+
* Assess if this issue is _critical_ (using the definition above).
41+
If so, assign P0 label and add the `front-line-handled` label. Then,
42+
ping the team chat, cc the Eng Manager, and share that a new P0
43+
regression / issue has been identified. In addition, reply to the issue
44+
to acknowledge that we believe this is a P0 issue and thank the
45+
author for their time.
46+
* If the issue is not _critical_ and thus not a P0, then add
47+
the `front-line-handled` label to the issue. This signals that you have
48+
looked at the issue as part of front-line triage.
49+
* If the issue looks legitimate, feel free to thank the author
50+
of the issue for their time. If a follow-up question is warranted,
51+
feel free to ask a follow-up question to help the second-line
52+
triage process.
53+
54+
### Periodic second-line triage
55+
56+
### Bi-weekly during the planning meeting
2457

2558
Check that existing issues are labeled and organized appropriately:
2659

@@ -29,24 +62,29 @@ Check that existing issues are labeled and organized appropriately:
2962
* Set a milestone to all [P0 and P1 issues][p0_p1_issues_without_milestone].
3063
* Add all [projectless open issues][projectless_open_issues] to the "genui" project.
3164

32-
Triage new issues:
65+
### Weekly during the planning meeting
3366

34-
* Open the [list of untriaged issues][untriaged_list].
35-
* For each issue in the list, do one of:
36-
* If we don't plan to fix the issue, close it with an explanation.
37-
* If we plan to fix the issue assign a priority label:
38-
[P0][P0], [P1][P1], [P2][P2], or [P3][P3]. If you don't know which priority
39-
to assign, apply `P2`. If an issue is `P0` or `P1`, add it to a milestone.
67+
Triage issues ready for second-line review:
68+
69+
* Open the [list of issues ready for second-line][ready-for-second-line].
70+
* For each issue in the list:
71+
* Do one of:
72+
* If we don't plan to fix the issue, close it with an explanation.
73+
* If we plan to fix the issue assign a priority label:
74+
[P0][P0], [P1][P1], [P2][P2], or [P3][P3]. If you don't know which priority
75+
to assign, apply `P2`. If an issue is `P0` or `P1`, add it to a milestone.
76+
* Add a label for `second-line-triaged`
4077

4178
At the end of a triage session, the untriaged issue list should be as close to
4279
empty as possible.
4380

81+
[for-front-line]: https://github.com/flutter/genui/issues?q=is%3Aissue%20state%3Aopen%20-label%3AP0%20%20-label%3AP1%20-label%3AP2%20%20-label%3AP3%20-label%3Afront-line-handled
4482
[flutter_guidelines]: https://github.com/flutter/flutter/blob/master/CONTRIBUTING.md
4583
[usage_md]: packages/flutter_genui/USAGE.md#configure-firebase
4684
[assigned_p2_p3_issues]: https://github.com/flutter/genui/issues?q=is%3Aopen%20is%3Aissue%20label%3AP2%2CP3%20assignee%3A*
4785
[p0_p1_issues_without_milestone]: https://github.com/flutter/genui/issues?q=is%3Aopen%20is%3Aissue%20label%3AP1%2CP0%20no%3Amilestone
4886
[projectless_open_issues]: https://github.com/flutter/genui/issues?q=is%3Aopen%20is%3Aissue%20no%3Aproject
49-
[untriaged_list]: https://github.com/flutter/genui/issues?q=is%3Aissue%20state%3Aopen%20-label%3AP0%20%20-label%3AP1%20-label%3AP2%20%20-label%3AP3
87+
[ready-for-second-line]: https://github.com/flutter/genui/issues?q=is%3Aissue%20state%3Aopen%20label%3Afront-line-handled%20-label%3Asecond-line-triaged
5088
[P0]: https://github.com/flutter/genui/labels?q=P0
5189
[P1]: https://github.com/flutter/genui/labels?q=P1
5290
[P2]: https://github.com/flutter/genui/labels?q=P2

0 commit comments

Comments
 (0)