Issue Triage Process

Overview of Triage Steps

The task force uses the following process to facilitate timely response to feedback that identifies potential bugs or inaccuracies in APG content. This page documents how the task force will execute these steps:

1. Intake: label bug, inaccuracy, or enhancement and assign person to bug reproduction step.
2. Bug reproduction documentation: Determine if reproduceable and appropriate next step.
3. Prioritization: Validate severity, assign priority, identify resolution pathway.
4. Non-reproduceable bug dispositioning: Seek clarification and either send back to prioritization or close as invalid or out of scope.

Who executes the steps

1. The task force regularly identifies members who wish to be included in the triage process team.
2. The triage team lead coordinates a rotation schedule to cover asynchronous intake, reproduction, and dispositioning work.

Intake Process Details

Intake is done assyncronously by the triage team member currently covering intake. Ideally, it is complete within 7 days of issue creation.

1. Determine : Is issue in scope for this triage process? To be in scope the issue must:
   1. Contain feedback about APG content.
   2. Identify one or more specific problems.
2. If not in scope, do not label and do not continue processing the issue. It will be handled via other means.
3. Add the feedback label.
4. Determine which of the following types of feedback apply and add the appropriate label:
   1. Bug: it is a potential problem with the functionality or design of an example or the website itself.
   2. Inaccuracy: It is a potential error in guidance or documentation.
   3. Enhancement: It is a request for a design change or new feature.
5. Identify the type of content effected and add the appropriate label:
   1. Example
   2. Pattern
   3. Practice
   4. Documentation
6. If issue is a bug:
   1. Assign team member or members who will document reproduction.
   2. Add a comment stating issue needs verification of reproduceability and mention anyone who is assigned.
7. If issue is not a bug, add agenda label.

Bug Reproduction Documentation Process Details

Bug reproduction is performed asynchronously. Ideally it is complete within seven days of the completion of intake.

1. Attempt to reproduce the bug on all relevant platforms, e.g., Windows, macOS, iOS, Android.
2. If reproduceable, clearly document reproduction steps in a comment unless the original author's steps are complete and unambiguous.
3. Following the bug severity framework, add a severity label (sev1, sev2, or sev3).
4. Add agenda label.

Prioritization Process Details

Prioritization is conducted during task force meetings. Ideally it is complete less than two weeks after issue creation.

Details to be written: Validate severity, assign priority, identify resolution pathway.

Non-Reproduceable Issue Dispositioning Process Details

Non-reproduceable issues are dispositioned asynchronously by the team member assigned to reproduction.

Details to bewritten: : Seek clarification and either send back to prioritization or close as invalid or out of scope.