From eee0a83cdadd29d2fed8fcb015cf8b21469cb9aa Mon Sep 17 00:00:00 2001 From: rhiaro Date: Mon, 6 May 2024 12:45:40 +0100 Subject: [PATCH 1/2] Tidy up; add Focus labels by default --- .../ISSUE_TEMPLATE/005-early-design-review.md | 32 ++++++++----- .../010-specification-review.md | 46 ++++++++++--------- 2 files changed, 45 insertions(+), 33 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/005-early-design-review.md b/.github/ISSUE_TEMPLATE/005-early-design-review.md index 9706bba..25c4dba 100644 --- a/.github/ISSUE_TEMPLATE/005-early-design-review.md +++ b/.github/ISSUE_TEMPLATE/005-early-design-review.md @@ -3,7 +3,7 @@ name: Early design review about: 'If you''d like the TAG to offer thoughts and guidance on an early-stage design direction ' title: '' -labels: 'Progress: untriaged, Review type: early review' +labels: 'Progress: untriaged, Review type: early review, Focus: API Design (pending), Focus: Accessibility (pending), Focus: Internationalization (pending), Focus: Web architecture (pending), Focus: Security (pending), Focus: Privacy (pending)' assignees: '' --- @@ -15,26 +15,34 @@ I'm requesting a TAG review of [feature name]. [One paragraph summary of idea, ideally copy-pasted from Explainer introduction] - Explainer¹ (minimally containing user needs and example code): [url] - - User research: [url to public summary/results of research] - Security and Privacy self-review²: [url] - - GitHub repo (if you prefer feedback filed there): [url] + - [ ] We have reviewed the TAG's [Web Platform Design Principles](https://www.w3.org/TR/design-principles/) + +**Discussion about the work:** + + - User research: [url to public summary/results of research] + - Tests: [url] | [wpt folder(s), if available] + - Key pieces of existing multi-stakeholder³ (e.g. developers, implementers, civil society) support, review or discussion of this specification: + - Chromium comments: [url] + - Mozilla comments: https://github.com/mozilla/standards-positions/issues/NNN + - WebKit comments: https://github.com/WebKit/standards-positions/issues/NNN + - Etc. + - Major unresolved issues with or opposition to this design: + +**Where / by whom the work is being done:** + + - GitHub repo: [url] - Primary contacts (and their relationship to the specification): - [name] ([github username]), [organization/s] (repeat as necessary, we recommend including group chairs and editors in this list) - Organization/project driving the design: [organization and/or project name] - External status/issue trackers for this feature (publicly visible, e.g. Chrome Status): - -Further details: - - - [ ] I have reviewed the TAG's [Web Platform Design Principles](https://www.w3.org/TR/design-principles/) - The group where the incubation/design work on this is being done (or is intended to be done in the future): - The group where standardization of this work is intended to be done ("unknown" if not known): - - Existing major pieces of multi-stakeholder review or discussion of this design: - - Major unresolved issues with or opposition to this design: - This work is being funded by: -You should also know that... +**You should also know that:** -[please tell us anything you think is relevant to this review] + - [please tell us anything else you think is relevant to this review] ------------------------------------------------------------------------------------ CAREFULLY READ AND DELETE CONTENT BELOW THIS LINE BEFORE SUBMITTING @@ -47,3 +55,5 @@ In particular: ¹ For background, see our [explanation of how to write a good explainer](https://tag.w3.org/explainers/). We recommend the explainer to be in [Markdown](https://github.github.com/gfm/). ² Even for early-stage ideas, a Security and Privacy questionnaire helps us understand potential security and privacy issues and mitigations for your design, and can save us asking redundant questions. See https://www.w3.org/TR/security-privacy-questionnaire/. + +³ For your own organization, you can simply state the organization's position instead of linking to it. Chromium doesn't have a standards-positions repository and [prefers](https://source.chromium.org/chromium/chromium/src/+/main:docs/standards/positions/GoogleChrome/README.md) to use comments from the teams that maintain the relevant area of their codebase. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/010-specification-review.md b/.github/ISSUE_TEMPLATE/010-specification-review.md index 23f8a18..2e17393 100644 --- a/.github/ISSUE_TEMPLATE/010-specification-review.md +++ b/.github/ISSUE_TEMPLATE/010-specification-review.md @@ -3,7 +3,7 @@ name: Specification review about: If you want the TAG to review a specification for Web technology that you're working on title: '' -labels: 'Progress: untriaged' +labels: 'Progress: untriaged, Focus: API Design (pending), Focus: Accessibility (pending), Focus: Internationalization (pending), Focus: Web architecture (pending), Focus: Security (pending), Focus: Privacy (pending)' assignees: '' --- @@ -15,43 +15,45 @@ I'm requesting a TAG review of [feature name]. [One paragraph summary of idea, ideally copy-pasted from Explainer introduction] - Explainer¹ (minimally containing user needs and example code): [url] - - Specification URL: [spec url] - - Tests: [wpt folder(s), if available] - - User research: [url to public summary/results of research] - Security and Privacy self-review²: [url] - - GitHub repo (if you prefer feedback filed there): [url] - - Primary contacts (and their relationship to the specification): - - [name] ([github username]), [organization/s] (repeat as necessary, we recommend including group chairs and editors in this list) - - Organization(s)/project(s) driving the specification: [organization and/or project name] - - Key pieces of existing multi-stakeholder (e.g. developers, implementers, civil society) support, review or discussion of this specification: + - [ ] We have reviewed the TAG's [Web Platform Design Principles](https://www.w3.org/TR/design-principles/) + +**Discussion about the work:** + + - User research: [url to public summary/results of research] + - Tests: [url] | [wpt folder(s), if available] + - Key pieces of existing multi-stakeholder³ (e.g. developers, implementers, civil society) support, review or discussion of this specification: - Chromium comments: [url] - Mozilla comments: https://github.com/mozilla/standards-positions/issues/NNN - WebKit comments: https://github.com/WebKit/standards-positions/issues/NNN - Etc. - - External status/issue trackers for this specification (publicly visible, e.g. Chrome Status): + - Major unresolved issues with or opposition to this design: -Further details: +**Where / by whom the work is being done:** - - [ ] I have reviewed the TAG's [Web Platform Design Principles](https://www.w3.org/TR/design-principles/) - - Relevant time constraints or deadlines: [please provide] - - The group where the work on this specification is currently being done: - - The group where standardization of this work is intended to be done (if current group is a community group or other incubation venue): - - Major unresolved issues with or opposition to this specification: + - GitHub repo: [url] + - Primary contacts (and their relationship to the specification): + - [name] ([github username]), [organization/s] (repeat as necessary, we recommend including group chairs and editors in this list) + - Organization/project driving the design: [organization and/or project name] + - External status/issue trackers for this feature (publicly visible, e.g. Chrome Status): + - The group where the incubation/design work on this is being done (or is intended to be done in the future): + - The group where standardization of this work is intended to be done ("unknown" if not known): - This work is being funded by: -You should also know that... +**You should also know that:** -[please tell us anything you think is relevant to this review] + - [please tell us anything else you think is relevant to this review] ------------------------------------------------------------------------------------ CAREFULLY READ AND DELETE CONTENT BELOW THIS LINE BEFORE SUBMITTING Please preview the issue and check that the links work before submitting. -In particular, if anything links to a URL which requires authentication (e.g. Google document), please make sure anyone with the link can access the document. We would prefer fully public documents though, since we work in the open. +In particular: +* if anything links to a URL which requires authentication (e.g. Google document), please make sure anyone with the link can access the document. We would prefer public documents though, since we work in the open. -¹ We require an explainer to give the relevant context for the spec review, even if the spec has some background information. For background, see our [explanation of how to write a good explainer](https://tag.w3.org/explainers/). We recommend the explainer to be in [Markdown](https://github.github.com/gfm/). +¹ For background, see our [explanation of how to write a good explainer](https://tag.w3.org/explainers/). We recommend the explainer to be in [Markdown](https://github.github.com/gfm/). -² A Security and Privacy questionnaire helps us understand potential security and privacy issues and mitigations for your design, and can save us asking redundant questions. See https://www.w3.org/TR/security-privacy-questionnaire/. +² Even for early-stage ideas, a Security and Privacy questionnaire helps us understand potential security and privacy issues and mitigations for your design, and can save us asking redundant questions. See https://www.w3.org/TR/security-privacy-questionnaire/. -³ For your own organization, you can simply state the organization's position instead of linking to it. Chromium doesn't have a standards-positions repository and [prefers](https://source.chromium.org/chromium/chromium/src/+/main:docs/standards/positions/GoogleChrome/README.md) to use comments from the teams that maintain the relevant area of their codebase. +³ For your own organization, you can simply state the organization's position instead of linking to it. Chromium doesn't have a standards-positions repository and [prefers](https://source.chromium.org/chromium/chromium/src/+/main:docs/standards/positions/GoogleChrome/README.md) to use comments from the teams that maintain the relevant area of their codebase. \ No newline at end of file From 8736424502dab758445e67e985174f0c5699e927 Mon Sep 17 00:00:00 2001 From: rhiaro Date: Mon, 6 May 2024 12:47:43 +0100 Subject: [PATCH 2/2] Issue template: fix bits dropped due to lazy copypaste --- .github/ISSUE_TEMPLATE/010-specification-review.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/010-specification-review.md b/.github/ISSUE_TEMPLATE/010-specification-review.md index 2e17393..7a75beb 100644 --- a/.github/ISSUE_TEMPLATE/010-specification-review.md +++ b/.github/ISSUE_TEMPLATE/010-specification-review.md @@ -52,8 +52,8 @@ Please preview the issue and check that the links work before submitting. In particular: * if anything links to a URL which requires authentication (e.g. Google document), please make sure anyone with the link can access the document. We would prefer public documents though, since we work in the open. -¹ For background, see our [explanation of how to write a good explainer](https://tag.w3.org/explainers/). We recommend the explainer to be in [Markdown](https://github.github.com/gfm/). +¹ We require an explainer to give the relevant context for the spec review, even if the spec has some background information. For background, see our [explanation of how to write a good explainer](https://tag.w3.org/explainers/). We recommend the explainer to be in [Markdown](https://github.github.com/gfm/). -² Even for early-stage ideas, a Security and Privacy questionnaire helps us understand potential security and privacy issues and mitigations for your design, and can save us asking redundant questions. See https://www.w3.org/TR/security-privacy-questionnaire/. +² A Security and Privacy questionnaire helps us understand potential security and privacy issues and mitigations for your design, and can save us asking redundant questions. See https://www.w3.org/TR/security-privacy-questionnaire/. ³ For your own organization, you can simply state the organization's position instead of linking to it. Chromium doesn't have a standards-positions repository and [prefers](https://source.chromium.org/chromium/chromium/src/+/main:docs/standards/positions/GoogleChrome/README.md) to use comments from the teams that maintain the relevant area of their codebase. \ No newline at end of file