Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 4.43 KB

triage.md

File metadata and controls

103 lines (77 loc) · 4.43 KB
Raw

Triage role

As we get more issues and pull requests opened on the GitHub CLI, we've decided on a weekly rotation triage role. The initial expectation is that the person in the role for the week spends no more than 2 hours a day on this work; we can refine that as needed.

Expectations for incoming issues

All incoming issues need either an enhancement, bug, or docs label.

To be considered triaged, enhancement issues require at least one of the following additional labels:

  • core: work reserved for the core CLI team
  • help wanted: work that we would accept contributions for
  • needs-design: work that requires input from a UX designer before it can move forward
  • needs-investigation: work that requires a mystery be solved by the core team before it can move forward
  • needs-user-input: work that requires more information from the reporter before it can move forward

To be considered triaged, bug issues require a severity label: one of p1, p2, or p3

For a more detailed breakdown of how to triage an issue, see the Issue triage flowchart below.

Expectations for community pull requests

To be considered triaged, incoming pull requests should:

  • be checked for a corresponding help wanted issue
  • be checked for basic quality: are the builds passing? have tests been added?
  • be checked for redundancy: is there already a PR dealing with this?

Once a pull request has been triaged, it should be moved to the Needs Review column of the project board.

For a more detailed breakdown of how to triage an issue, see the PR triage flowchart below.

Issue triage flowchart

  • can this be closed outright?
    • e.g. spam/junk
    • close without comment
  • do we not want to do it?
    • e.g. have already discussed not wanting to do or duplicate issue
    • comment and close
  • are we ok with outside contribution for this?
    • e.g. the task is relatively straightforward, but no people on our team have the bandwidth to take it on at the moment
    • ensure that the thread contains all the context necessary for someone new to pick this up
    • add help wanted label
    • consider adding good first issue label
  • do we want to do it?
    • comment acknowledging it
    • add core label
    • add to project TODO column if this is something that should ship soon
  • is it intriguing, but requires discussion?
    • label needs-design if design input is needed, ping
    • label needs-investigation if engineering research is required before action can be taken
  • does it need more info from the issue author?
    • ask the user for details
    • add needs-user-input label
  • is it a usage/support question?
    • offer some instructions/workaround and close

Pull request triage flowchart

  • can it be closed outright?
    • e.g. spam/junk
    • close
  • do we not want to do it?
    • comment and close
  • is it intriguing, but requires discussion and there is no referenced issue?
    • request an issue
    • close
  • is it something we want to include?
    • add to needs review column

Weekly PR audit

In the interest of not letting our open PR list get out of hand (20+ total PRs or multiple PRs over a few months old), try to audit open PRs each week with the goal of getting them merged and/or closed. It's likely too much work to deal with every PR, but even getting a few closer to done is helpful.

For each PR, ask:

  • is this too stale (more than two months old or too many conflicts)? close with comment
  • is this really close but author is absent? push commits to finish, request review
  • is this waiting on triage? go through the PR triage flow

Useful aliases

This gist has some useful aliases for first responders:

https://gist.github.com/vilmibm/ee6ed8a783e4fef5b69b2ed42d743b1a

Examples

We want our project to be a safe and encouraging open-source environment. Below are some examples of how to empathetically respond to or close an issue/PR: