-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Process: Add documentation for labels, current and proposed
Co-authored-by: Anssi Kostiainen <[email protected]>
- Loading branch information
1 parent
d1a02f2
commit 6b6453a
Showing
2 changed files
with
104 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Triage Guidance for WebNN Repo | ||
|
||
TODO: Consider removing these, or fit these into the documentation below. | ||
|
||
- **enhancement** - unclear if this is about the spec text, the proposed API, etc. Prefer **feature request** etc. | ||
- **help wanted** - unclear what help is needed; use **needs PR** or **question** instead? | ||
|
||
|
||
## Label Usage | ||
|
||
Labels are used for: | ||
|
||
- Understanding the status of a specific issue and next steps to resolve it. | ||
- Understanding the scope of work remaining on broad efforts (e.g. aligning with best practices, fixing normative issues, etc) | ||
- Identifying areas to contribute. | ||
|
||
The working group chairs and spec editors should regularly review bugs and ensure that labels are accurate, and ensure that issues are getting appropriate attention; for example, scheduling discussion of new feature requests, discussion to resolve outstanding questions, and drawing attention to issues that are ready for a contributor to author a PR. | ||
|
||
|
||
## Types | ||
|
||
Every issue should have one of these issue types, and only rarely more than one. | ||
|
||
- **bug** - a flaw in the specification that will require a normative fix; for example, an algorithm 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 | ||
|
||
|
||
## 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). | ||
|
||
Other issues are generally assumed to require [substantive changes](https://www.w3.org/2023/Process-20231103/#substantive-change). | ||
|
||
|
||
## Workstream | ||
|
||
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. | ||
|
||
|
||
## 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 | ||
|
||
|
||
- **needs PR** - _PROPOSED_ - when an issue has enough discussion that the next step is to author a PR for review | ||
- **has PR** - _PROPOSED_ - the issue has a corresponding PR which should be reviewed | ||
|
||
- **needs WPT** - _PROPOSED_ - a corresponding Web Platform Test should be filed, either to capture new behavior or cover a gap | ||
- **has WPT** - _PROPOSED_ - test coverage exists (either merged or in review) | ||
|
||
|
||
## 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** | ||
|
||
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 | ||
|
||
Implicitly, all issues not tagged **v2** must be resolved before the specification should advance to the next maturity level. | ||
|
||
TODO: Consider using milestones instead. | ||
|
||
|
||
## Horizontal Reviews | ||
|
||
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 | ||
|
||
|
||
## Label Administration | ||
|
||
If you think a new label should be introduced, an old label retired, or the usage of a label reconsidered, please file a PR modifying this file including the proposed change. |