Skip to content

Commit 745ddbc

Browse files
authored
Update Triage Guidance (#568)
Introduces label links to: - Help readers get to issues directly - Add visual cues (links render as colorful pills)
1 parent cfab815 commit 745ddbc

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

docs/IssueTriage.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ The working group chairs and spec editors should regularly review bugs and ensur
1515

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

18-
- **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
19-
- **conventions** - where the spec does not conform to specification best practices from Web IDL, Bikeshed, Infra, etc.
20-
- **use case** - a new use case for the API that should be documented or considered; may spawn other issues
21-
- **process** - a meta issue about how the specification is evolved; for example, a discussion of issue labels
22-
- **testing** - discussion of test coverage
23-
- **feature request** - suggestion for an addition to the proposed API
18+
- 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
19+
- https://github.com/webmachinelearning/webnn/labels/conventions - where the spec does not conform to specification best practices from Web IDL, Bikeshed, Infra, etc.
20+
- 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
21+
- https://github.com/webmachinelearning/webnn/labels/process - a meta issue about how the specification is evolved; for example, a discussion of issue labels
22+
- https://github.com/webmachinelearning/webnn/labels/testing - discussion of test coverage
23+
- https://github.com/webmachinelearning/webnn/labels/feature%20request - suggestion for an addition to the proposed API
2424

2525

2626
## Spec Impact
2727

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

30-
- **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).
30+
- 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).
3131

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

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

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

39-
- **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.
40-
- **operator specific** - issues regarding the specification of a single operator or small number of operators
41-
- **webgpu interop** - interop between WebNN and WebGPU, e.g. timelines, buffers, devices.
39+
- 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.
40+
- https://github.com/webmachinelearning/webnn/labels/operator%20specific - issues regarding the specification of a single operator or small number of operators
41+
- https://github.com/webmachinelearning/webnn/labels/webgpu%20interop - interop between WebNN and WebGPU, e.g. timelines, buffers, devices.
4242

4343

4444
## Next Steps
4545

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

4949

5050
## Resolved Issues
5151

5252
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.
5353

54-
- **duplicate**
55-
- **invalid**
56-
- **spam**
57-
- **wontfix**
54+
- https://github.com/webmachinelearning/webnn/labels/duplicate
55+
- https://github.com/webmachinelearning/webnn/labels/invalid
56+
- https://github.com/webmachinelearning/webnn/labels/spam
57+
- https://github.com/webmachinelearning/webnn/labels/wontfix
5858

5959
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.
6060

6161

6262
## Timeline
6363

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

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

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

7171
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.
7272

73-
- **a11y-needs-resolution** - raised by Accessibility Group
74-
- **a11y-tracker** - bring to attention of Accessibility Group
75-
- **i18n-needs-resolution** - raised by Internationalization Group
76-
- **i18n-tracker** - bring to attention of Internationalization Group
77-
- **privacy-needs-resolution** - raised by Privacy Group
78-
- **privacy-tracker** - bring to attention of Privacy Group
79-
- **security-needs-resolution** - raised by Security Group
80-
- **security-tracker** - bring to attention of Security Group
81-
- **tag-needs-resolution** - raised by Technical Architecture Group
82-
- **tag-tracker** - bring to attention of Technical Architecture Group
73+
- https://github.com/webmachinelearning/webnn/labels/a11y-needs-resolution - raised by Accessibility Group
74+
- https://github.com/webmachinelearning/webnn/labels/a11y-tracker - bring to attention of Accessibility Group
75+
- https://github.com/webmachinelearning/webnn/labels/i18n-needs-resolution - raised by Internationalization Group
76+
- https://github.com/webmachinelearning/webnn/labels/i18n-tracker - bring to attention of Internationalization Group
77+
- https://github.com/webmachinelearning/webnn/labels/privacy-needs-resolution - raised by Privacy Group
78+
- https://github.com/webmachinelearning/webnn/labels/privacy-tracker - bring to attention of Privacy Group
79+
- https://github.com/webmachinelearning/webnn/labels/security-needs-resolution - raised by Security Group
80+
- https://github.com/webmachinelearning/webnn/labels/security-tracker - bring to attention of Security Group
81+
- https://github.com/webmachinelearning/webnn/labels/tag-needs-resolution - raised by Technical Architecture Group
82+
- https://github.com/webmachinelearning/webnn/labels/tag-tracker - bring to attention of Technical Architecture Group
8383

8484

8585
## Label Administration

0 commit comments

Comments
 (0)