Skip to content

Commit

Permalink
Update Triage Guidance (webmachinelearning#568)
Browse files Browse the repository at this point in the history
Introduces label links to:
- Help readers get to issues directly
- Add visual cues (links render as colorful pills)
  • Loading branch information
anssiko authored Feb 15, 2024
1 parent cfab815 commit 745ddbc
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions docs/IssueTriage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ The working group chairs and spec editors should regularly review bugs and ensur

Every issue should have one of these issue types, and only rarely more than one.

- **bug** - a gap or flaw in the specification that will require a normative fix; for example, an algorithm is missing or computes an output incorrectly
- **conventions** - where the spec does not conform to specification best practices from Web IDL, Bikeshed, Infra, etc.
- **use case** - a new use case for the API that should be documented or considered; may spawn other issues
- **process** - a meta issue about how the specification is evolved; for example, a discussion of issue labels
- **testing** - discussion of test coverage
- **feature request** - suggestion for an addition to the proposed API
- https://github.com/webmachinelearning/webnn/labels/bug - a gap or flaw in the specification that will require a normative fix; for example, an algorithm is missing or computes an output incorrectly
- https://github.com/webmachinelearning/webnn/labels/conventions - where the spec does not conform to specification best practices from Web IDL, Bikeshed, Infra, etc.
- https://github.com/webmachinelearning/webnn/labels/use%20case - a new use case for the API that should be documented or considered; may spawn other issues
- https://github.com/webmachinelearning/webnn/labels/process - a meta issue about how the specification is evolved; for example, a discussion of issue labels
- https://github.com/webmachinelearning/webnn/labels/testing - discussion of test coverage
- https://github.com/webmachinelearning/webnn/labels/feature%20request - suggestion for an addition to the proposed API


## Spec Impact

These broad categories describe the projected impact on the specification and implementation of an issue.

- **editorial** - spec text or styling could be improved, but does not imply changes that functionally affect the interpretation. See [editorial changes](https://www.w3.org/2023/Process-20231103/#editorial-change).
- https://github.com/webmachinelearning/webnn/labels/editorial - spec text or styling could be improved, but does not imply changes that functionally affect the interpretation. See [editorial changes](https://www.w3.org/2023/Process-20231103/#editorial-change).

Other issues are generally assumed to require [substantive changes](https://www.w3.org/2023/Process-20231103/#substantive-change).

Expand All @@ -36,32 +36,32 @@ Other issues are generally assumed to require [substantive changes](https://www.

WebNN has several workstreams specific to the API proposal. These labels help group related issues and measure progress.

- **opset** - discussions about the overall operator coverage of WebNN; examples include alignment with other published operator sets, use cases that require multiple new operators, compatibility with implementations, etc.
- **operator specific** - issues regarding the specification of a single operator or small number of operators
- **webgpu interop** - interop between WebNN and WebGPU, e.g. timelines, buffers, devices.
- https://github.com/webmachinelearning/webnn/labels/opset - discussions about the overall operator coverage of WebNN; examples include alignment with other published operator sets, use cases that require multiple new operators, compatibility with implementations, etc.
- https://github.com/webmachinelearning/webnn/labels/operator%20specific - issues regarding the specification of a single operator or small number of operators
- https://github.com/webmachinelearning/webnn/labels/webgpu%20interop - interop between WebNN and WebGPU, e.g. timelines, buffers, devices.


## Next Steps

- **question** - there is outstanding discussion needed on the issue before progress can be made
- **good first issue** - issues that do not require significant context for new contributors
- https://github.com/webmachinelearning/webnn/labels/question - there is outstanding discussion needed on the issue before progress can be made
- https://github.com/webmachinelearning/webnn/labels/good%20first%20issue - issues that do not require significant context for new contributors


## Resolved Issues

These labels can be applied to issues when the issue is closed. This is helpful to capture why the issue was closed if it isn't clear from context.

- **duplicate**
- **invalid**
- **spam**
- **wontfix**
- https://github.com/webmachinelearning/webnn/labels/duplicate
- https://github.com/webmachinelearning/webnn/labels/invalid
- https://github.com/webmachinelearning/webnn/labels/spam
- https://github.com/webmachinelearning/webnn/labels/wontfix

NOTE: GitHub supports two different actions when closing an issue: "Close as completed (Done, closed, fixed, resolved)" and "Close as not planned (Won't fix, can't repo, duplicate, stale)". The UI is subtle, but contributors are encouraged to select an appropriate resolution to assist with future review of issues, in addition to selecting an appropriate label.


## Timeline

- **v2**- issue is not considered a blocker for Proposed Recommendation
- https://github.com/webmachinelearning/webnn/labels/v2 - issue is not considered a blocker for Proposed Recommendation

Implicitly, all issues not tagged **v2** must be resolved before the specification should advance to the next maturity level.

Expand All @@ -70,16 +70,16 @@ Implicitly, all issues not tagged **v2** must be resolved before the specificati

These labels will generally be applied to issues by a W3C horizontal review group or to bring an issue to the attention of this group for feedback. These labels are common across W3C spec repos.

- **a11y-needs-resolution** - raised by Accessibility Group
- **a11y-tracker** - bring to attention of Accessibility Group
- **i18n-needs-resolution** - raised by Internationalization Group
- **i18n-tracker** - bring to attention of Internationalization Group
- **privacy-needs-resolution** - raised by Privacy Group
- **privacy-tracker** - bring to attention of Privacy Group
- **security-needs-resolution** - raised by Security Group
- **security-tracker** - bring to attention of Security Group
- **tag-needs-resolution** - raised by Technical Architecture Group
- **tag-tracker** - bring to attention of Technical Architecture Group
- https://github.com/webmachinelearning/webnn/labels/a11y-needs-resolution - raised by Accessibility Group
- https://github.com/webmachinelearning/webnn/labels/a11y-tracker - bring to attention of Accessibility Group
- https://github.com/webmachinelearning/webnn/labels/i18n-needs-resolution - raised by Internationalization Group
- https://github.com/webmachinelearning/webnn/labels/i18n-tracker - bring to attention of Internationalization Group
- https://github.com/webmachinelearning/webnn/labels/privacy-needs-resolution - raised by Privacy Group
- https://github.com/webmachinelearning/webnn/labels/privacy-tracker - bring to attention of Privacy Group
- https://github.com/webmachinelearning/webnn/labels/security-needs-resolution - raised by Security Group
- https://github.com/webmachinelearning/webnn/labels/security-tracker - bring to attention of Security Group
- https://github.com/webmachinelearning/webnn/labels/tag-needs-resolution - raised by Technical Architecture Group
- https://github.com/webmachinelearning/webnn/labels/tag-tracker - bring to attention of Technical Architecture Group


## Label Administration
Expand Down

0 comments on commit 745ddbc

Please sign in to comment.