hyperium / hyperium/hyper

Create a bug/triage checklist

Open
#3,215 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-meta B-rfc
Dominant language
Rust
Stars
16.3k
Forks
1.8k
Avg merge
1d 22h
Merged PRs (30d)
14

Description

This is an action item of the COE on hyper's surprise CVE:

There is a triage guide for bug reports, which is a good thing. But that doesn’t mean everyone (me included!) always remembers all the steps. Checklists are famous in aviation and medicine for their effectiveness in saving lives. They can also help us make sure all issues are treated properly.

Making sure the checklist is complete would be part of the routine decided on in #3214.

If I just take the headlines from the triager's guide, they would be this:

  1. Acknowledge
  2. Ask for more info
  3. Categorize
  4. Adjust the title
  5. Mentor

I think there's a need to fill in a few more items for step 2, "Ask for more info".

There's also a question of how to make sure we complete the checklist for each bug report. One idea I had was to setup an autoresponder bot which includes the checklist in markdown checkbox form. Then the first comment would always have it, and triagers should have "edit" permissions which would be required to check them off.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the hyper triage guide linked in the issue and the routine proposed in #3214; compare the existing steps with the missing details for “Ask for more info.” Resolve whether the deliverable is a checklist, an autoresponder, or both, then define completion by a documented checklist that triagers can follow.

Written by the indexing model from the issue text.

Assessment

Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.