Skip to content

Latest commit

 

History

History
88 lines (53 loc) · 5.84 KB

IssueTriage.md

File metadata and controls

88 lines (53 loc) · 5.84 KB
Raw

Triage Guidance for WebNN Repo

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

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.

Other issues are generally assumed to require substantive changes.

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.
  • interop - issues arising from differences between backends
  • device selection - discussions about device selection mechanisms

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

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.

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.

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 Issue the Accessibility Group has raised and looks for a response on. - raised by Accessibility Group
  • a11y-tracker Group bringing to attention of a11y, or tracked by the a11y Group but not needing response. - bring to attention of Accessibility Group
  • i18n-needs-resolution Issue the Internationalization Group has raised and looks for a response on. - raised by Internationalization Group
  • i18n-tracker Group bringing to attention of Internationalization, or tracked by i18n but not needing response. - bring to attention of Internationalization Group
  • privacy-needs-resolution Issue the Privacy Group has raised and looks for a response on. - raised by Privacy Group
  • privacy-tracker Group bringing to attention of Privacy, or tracked by the Privacy Group but not needing response. - bring to attention of Privacy Group
  • security-needs-resolution Issue the security Group has raised and looks for a response on. - raised by Security Group
  • security-tracker Group bringing to attention of security, or tracked by the security Group but not needing response. - bring to attention of Security Group
  • tag-needs-resolution Issue the Technical Architecture Group has raised and looks for a response on. - raised by Technical Architecture Group
  • tag-tracker Group bringing to attention of the TAG, or tracked by the TAG but not needing response. - 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.