Issue Triage Process

Purpose and Overview of Process Steps

The APG task force issue triage process is intended to:

1. Facilitate timely response to external feedback and questions.
2. Provide consistent issue labeling that supports effective backlog management.

This page documents how the task force will execute the following process steps:

1. Intake: label as bug, inaccuracy, enhancement, or question and determine next step.
2. Bug reproduction documentation: If issue is a bug, determine if reproducible and appropriate next step.
3. Prioritization: Validate severity, assign priority, and identify resolution pathway.
4. Non-reproducible 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:
   1. Alignment on time commitments, e.g. 1 hour per rotation.
   2. A schedule that specifies who works on intake and who works on bug reproduction/dispositioning during each rotation.

Intake Process Details

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

After this step in the process is complete, if the issue is a bug it will advance to the reproduction documentation step. Other issues are labeled as "Ready to Prioritize".

1. Add the feedback label to identify the issue as input from outside the task force.
2. Categorize the feedback by adding one or more of the following labels:
   1. Bug: Potential problem with the functionality or design of an example or the website itself.
   2. Inaccuracy: A potentially incorrect statement in prose (not a code bug)
   3. Enhancement: Request for Any addition or improvement that doesn't fix a code bug or prose inaccuracy
   4. Question: It contains a question about APG content
   5. Out of Scope: Not an APG issue
3. Identify if the issue is related to one of the following types of pages and add the appropriate label:
   1. Example page
   2. Pattern page
   3. Practice page
   4. About Page
4. If issue is not a bug, add agenda label.
5. If issue is a bug:
   1. Assign team member or members who will document reproduction.
   2. Add a comment stating issue needs verification of reproducibility and mention anyone who is assigned.

Bug Reproduction Documentation Process Details

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

After this step in the process is complete, if the bug is reproduceable, it is flagged as agenda ready so it can be prioritized.

1. Attempt to reproduce the bug on all relevant platforms, e.g., Windows, macOS, iOS, Android.
2. If reproducible, 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-Reproducible Issue Dispositioning Process Details

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

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