Skip to content

Commit eb06ccf

Browse files
Process: Add documentation for labels, current and proposed (#533)
* Process: Add documentation for labels, current and proposed Co-authored-by: Anssi Kostiainen <[email protected]>
1 parent a2f7e0a commit eb06ccf

File tree

3 files changed

+90
-2
lines changed

3 files changed

+90
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,11 @@ Wording change does not require opening a GitHub Issue, as the change in the pul
2323

2424
Similarly, a stylistic change does not necessarily require opening a GitHub Issue. It does, however, require buy-ins from the Working Group to proceed. The best way to propose this type of change is to attend one of the bi-weekly Web Machine Learning Working Group teleconference calls. A practical way to reach out to the Working Group to get invited to the teleconference call is to post a GitHub Issue giving a rough explanation of the proposed change and ask to be invited.
2525

26-
Follow the guidance in [SpecCodingConventions.md](SpecCodingConventions.md) for your change to ensure it aligns with best practices and existing conventions.
26+
Follow the guidance in [SpecCodingConventions.md](docs/SpecCodingConventions.md) for your change to ensure it aligns with best practices and existing conventions.
2727

2828
Bug fixes and new content changes should proceed as follows:
29-
1. **Open an issue in GitHub Issues** with a brief description of the problem and a potential solution if it's not already obvious. A proposal or suggestion for improvement may need a bit more explanation with possible references to related information. An active issue is the best way to get attention. Members of the Working Group scan active issues constantly.
29+
1. **Open an issue in GitHub Issues** with a brief description of the problem and a potential solution if it's not already obvious. A proposal or suggestion for improvement may need a bit more explanation with possible references to related information. An active issue is the best way to get attention. Members of the Working Group scan active issues constantly and should apply labels to help categorize them, following the guidance in [IssueTriage.md](docs/IssueTriage.md). If you're a member of the Working Group, please apply appropriate labels to the new issue.
30+
3031
2. **Prepare the change in a pull request** and put a reference to the active issue(s) the change is addressing in the description. We prefer that a pull request is represented by a single type of change as outlined in the previous section for a speedy review and approval. Conversely, a specific change should also be captured by a single and not multiple pull requests. This helps to reduce the dependency between pull requests and the chance for the specification to be left in a transient state between multiple pull requests. Exceptions to this should be discussed and approved by the Working Group in one of our bi-weekly calls.
3132

3233
3. **Close the issue** once the pull request is reviewed and merged. Make sure to resolve any error that arises during the merge and check the post-merged published result. The Bikeshed document format isn't very good for an automatic merge, you may need to intervene and manually correct the merge's mistakes if any. You also want to make sure all the GitHub Actions that are put in place to catch document issues are all clean before merging the change into the main branch.

docs/IssueTriage.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Triage Guidance for WebNN Repo
2+
3+
## Label Usage
4+
5+
Labels are used for:
6+
7+
- Understanding the status of a specific issue and next steps to resolve it.
8+
- Understanding the scope of work remaining on broad efforts (e.g. aligning with best practices, fixing normative issues, etc)
9+
- Identifying areas to contribute.
10+
11+
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.
12+
13+
14+
## Types
15+
16+
Every issue should have one of these issue types, and only rarely more than one.
17+
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
24+
25+
26+
## Spec Impact
27+
28+
These broad categories describe the projected impact on the specification and implementation of an issue.
29+
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).
31+
32+
Other issues are generally assumed to require [substantive changes](https://www.w3.org/2023/Process-20231103/#substantive-change).
33+
34+
35+
## Workstream
36+
37+
WebNN has several workstreams specific to the API proposal. These labels help group related issues and measure progress.
38+
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.
42+
43+
44+
## Next Steps
45+
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
48+
49+
50+
## Resolved Issues
51+
52+
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.
53+
54+
- **duplicate**
55+
- **invalid**
56+
- **spam**
57+
- **wontfix**
58+
59+
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.
60+
61+
62+
## Timeline
63+
64+
- **v2**- issue is not considered a blocker for Proposed Recommendation
65+
66+
Implicitly, all issues not tagged **v2** must be resolved before the specification should advance to the next maturity level.
67+
68+
69+
## Horizontal Reviews
70+
71+
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.
72+
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
83+
84+
85+
## Label Administration
86+
87+
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.
File renamed without changes.

0 commit comments

Comments
 (0)