github.com/ungtb10d/cli/v2@v2.0.0-20221110210412-98537dd9d6a1/docs/triage.md (about)

     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  2 hours a day on this work; we can refine that as needed.
     6  
     7  ## Expectations for incoming issues
     8  
     9  All incoming issues need either an `enhancement`, `bug`, or `docs` label.
    10  
    11  To be considered triaged, `enhancement` issues require at least one of the following additional labels:
    12  
    13  - `core`: reserved for the core CLI team
    14  - `help wanted`: signal that we are accepting contributions for this
    15  - `discuss`: add to our team's queue to discuss during a sync
    16  - `needs-investigation`: work that requires a mystery be solved by the core team before it can move forward
    17  - `needs-user-input`: we need more information from our users before the task can move forward
    18  
    19  To be considered triaged, `bug` issues require a severity label: one of `p1`, `p2`, or `p3`
    20  
    21  ## Expectations for community pull requests
    22  
    23  All incoming pull requests are assigned to one of the engineers for review on a round-robin basis.
    24  The person in a triage role for a week could take a glance at these pull requests, mostly to see whether
    25  the changeset is feasible and to allow the associated CI run for new contributors.
    26  
    27  ## Issue triage flowchart
    28  
    29  - can this be closed outright?
    30    - e.g. spam/junk
    31    - close without comment
    32  - do we not want to do it?
    33    - e.g. have already discussed not wanting to do or duplicate issue
    34    - comment and close
    35  - are we ok with outside contribution for this?
    36    - e.g. the task is relatively straightforward, but no people on our team have the bandwidth to take it on at the moment
    37    - ensure that the thread contains all the context necessary for someone new to pick this up
    38    - add `help wanted` label
    39    - consider adding `good first issue` label
    40  - do we want to do it?
    41    - comment acknowledging that
    42    - add `core` label
    43    - add to the project “TODO” column if this is something that should ship soon
    44  - is it intriguing, but requires discussion?
    45    - label `discuss`
    46    - label `needs-investigation` if engineering research is required before action can be taken
    47  - does it need more info from the issue author?
    48    - ask the user for details
    49    - add `needs-user-input` label
    50  - is it a usage/support question?
    51    - consider converting the Issue to a Discussion
    52  
    53  ## Weekly PR audit
    54  
    55  In the interest of not letting our open PR list get out of hand (20+ total PRs _or_ multiple PRs
    56  over a few months old), try to audit open PRs each week with the goal of getting them merged and/or
    57  closed. It's likely too much work to deal with every PR, but even getting a few closer to done is
    58  helpful.
    59  
    60  For each PR, ask:
    61  
    62  - is this too stale (more than two months old or too many conflicts)? close with comment
    63  - is this really close but author is absent? push commits to finish, request review
    64  - is this waiting on triage? go through the PR triage flow
    65  
    66  ## Useful aliases
    67  
    68  This gist has some useful aliases for first responders:
    69  
    70  https://gist.github.com/vilmibm/ee6ed8a783e4fef5b69b2ed42d743b1a
    71  
    72  ## Examples
    73  
    74  We want our project to be a safe and encouraging open-source environment. Below are some examples
    75  of how to empathetically respond to or close an issue/PR:
    76  
    77  - [Closing a quality PR its scope is too large](https://github.com/ungtb10d/cli/pull/1161)
    78  - [Closing a stale PR](https://github.com/ungtb10d/cli/pull/557#issuecomment-639077269)
    79  - [Closing a PR that doesn't follow our CONTRIBUTING policy](https://github.com/ungtb10d/cli/pull/864)
    80  - [Responding to a bug report](https://github.com/desktop/desktop/issues/9195#issuecomment-592243129)
    81  - [Closing an issue that out of scope](https://github.com/ungtb10d/cli/issues/777#issuecomment-612926229)
    82  - [Closing an issue with a feature request](https://github.com/desktop/desktop/issues/9722#issuecomment-625461766)