Skip to content

Commit 85b4183

Browse files
author
Nate Smith
authored
Merge pull request cli#1129 from cli/triage-docs
add docs about new triage rotation
2 parents fb7fdc3 + c8dde91 commit 85b4183

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

docs/triage.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Triage role
2+
3+
As we get more issues and pull requests opened on the GitHub CLI, we've decided on a weekly rotation
4+
triage role. The initial expectation is that the person in the role for the week spends no more than
5+
1-2 hours a day on this work; we can refine that as needed.
6+
7+
# Incoming issues
8+
9+
just imagine a flowchart
10+
11+
- can this be closed outright?
12+
- e.g. spam/junk
13+
- close without comment
14+
- do we not want to do it?
15+
- e.g. have already discussed not wanting to do or duplicate issue
16+
- comment acknowledging receipt
17+
- close
18+
- do we want to do it?
19+
- e.g. bugs or things we have discussed before
20+
- comment acknowledging it
21+
- label appropriately (examples include `enhancement` or `bug`)
22+
- add to project TODO column if appropriate, otherwise just leave it labeled
23+
- is it intriguing but needs discussion?
24+
- label `needs-design` if design input is needed, ping
25+
- label `needs-investigation` if engineering research is required before action can be taken
26+
- ping engineers if eng needed
27+
- ping product if it's about future directions/roadamp/big changes
28+
- does it need more info from the issue author?
29+
- ask the user for that
30+
- add `needs-user-input` label
31+
- is it a user asking for help and you have all the info you need to help?
32+
- try and help
33+
34+
# Incoming PRs
35+
36+
just imagine a flowchart
37+
38+
- can it be closed outright?
39+
- ie spam/junk
40+
- do we not want to do it?
41+
- ie have already discussed not wanting to do, duplicate issue
42+
- comment acknowledging receipt
43+
- close
44+
- is it intriguing but needs discussion?
45+
- request an issue
46+
- close
47+
- is it something we want to include?
48+
- add `community` label
49+
- add to `needs review` column
50+
51+
# Weekly PR audit
52+
53+
In the interest of not letting our open PR list get out of hand (20+ total PRs _or_ multiple PRs
54+
over a few months old), try to audit open PRs each week with the goal of getting them merged and/or
55+
closed. It's likely too much work to deal with every PR, but even getting a few closer to done is
56+
helpful.
57+
58+
For each PR, ask:
59+
60+
- is this too stale? close with comment
61+
- is this really close but author is absent? push commits to finish, request review
62+
- is this waiting on triage? go through the PR triage flow

0 commit comments

Comments
 (0)