Skip to content

Commit 7caa3b1

Browse files
Process: Add documentation for labels, current and proposed
1 parent 4cfbfb0 commit 7caa3b1

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

CONTRIBUTING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ Similarly, a stylistic change does not necessarily require opening a GitHub Issu
2626
Follow the guidance in [SpecCodingConventions.md](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](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.

IssueTriage.md

+3
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,15 @@ These broad categories describe the projected impact on the specification and im
4040

4141
TODO: I'm not convinced of the utility of these; maybe drop them?
4242

43+
4344
## Issue Scope
4445

4546
Every issue should have at least one of these issue types, but occasionally multiple.
4647

4748
- **operation set** - 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.
4849
- **operator specific** - _PROPOSED_ - issues regarding the specification of a single operator or small number of operators
4950

51+
5052
## Next Steps
5153

5254
- **question** - there is outstanding discussion needed on the issue before progress can be made
@@ -59,6 +61,7 @@ Every issue should have at least one of these issue types, but occasionally mult
5961
- **needs WPT** - _PROPOSED_ - a corresponding Web Platform Test should be filed, either to capture new behavior or cover a gap
6062
- **has WPT** - _PROPOSED_ - test coverage exists (either merged or in review)
6163

64+
6265
## Resolved Issues
6366

6467
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.

0 commit comments

Comments
 (0)