Skip to content

Commit b4daffe

Browse files
authored
Add an Investigation Effort Proposal template (#130)
This completes the public documentation for Interop 2023 proposals.
1 parent 7396f86 commit b4daffe

File tree

3 files changed

+56
-21
lines changed

3 files changed

+56
-21
lines changed
Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,29 @@
1-
name: Proposal
2-
description: Proposal for feature to include in Interop 2023
3-
labels: proposal
1+
name: Focus Area Proposal
2+
description: Proposal for an Interop 2023 Focus Area
3+
labels: focus-area-proposal
44
body:
55
- type: markdown
66
attributes:
77
value: |
8-
**Interop 2023 has not yet launched and this documentation is still being finalized. Please do not submit proposals yet.**
9-
108
Thanks for taking the time to make a proposal for Interop 2023!
119
1210
Please see the [Interop 2023 README](https://github.com/web-platform-tests/interop/blob/main/2023/README.md) for the timeline and what to expect from the process.
11+
12+
If this feature is widely implemented, but lacks a high quality specification or tests, an [Investigation Effort](https://github.com/web-platform-tests/interop/issues/new?template=investigation-effort-proposal.yml) may be more appropriate.
1313
- type: textarea
1414
attributes:
1515
label: Description
1616
description: Brief description of the feature. Try to be clear about what parts of the feature are included and not.
17+
- type: textarea
18+
attributes:
19+
label: Rationale
20+
description: |
21+
Reasons for including the feature. A few dimensions to consider are:
22+
23+
- Web developer sentiment from polls or surveys, for example, [MDN surveys](https://insights.developer.mozilla.org/) or [State of CSS](https://stateofcss.com/).
24+
- Examples of sites or libraries working around a missing feature or browser bug.
25+
- Browser bugs or browser bug statistics, for example, [Chromium](https://bugs.chromium.org/), [Gecko](https://bugzilla.mozilla.org/), or [WebKit](https://bugs.webkit.org/).
26+
- Current usage of the feature, for example, [Chrome use counters](https://www.chromestatus.com/metrics/feature/popularity) or [HTTP Archive](https://httparchive.org/).
1727
- type: textarea
1828
attributes:
1929
label: Specification
@@ -28,14 +38,7 @@ body:
2838
- type: textarea
2939
attributes:
3040
label: Tests
31-
description: Tests for the feature in web-platform-tests on [wpt.fyi](https://wpt.fyi/), or in Test262 on [test262.report](https://test262.report/).
32-
- type: textarea
33-
attributes:
34-
label: Rationale
3541
description: |
36-
Reasons for including the feature. A few dimensions to consider are:
42+
Tests for the feature in web-platform-tests on [wpt.fyi](https://wpt.fyi/), or in Test262 on [test262.report](https://test262.report/).
3743
38-
- Web developer sentiment from polls or surveys, for example, [MDN surveys](https://insights.developer.mozilla.org/) or [State of CSS](https://stateofcss.com/).
39-
- Examples of sites or libraries working around a missing feature or browser bug.
40-
- Browser bugs or browser bug statistics, for example, [Chromium](https://bugs.chromium.org/), [Gecko](https://bugzilla.mozilla.org/), or [WebKit](https://bugs.webkit.org/).
41-
- Current usage of the feature, for example, [Chrome use counters](https://www.chromestatus.com/metrics/feature/popularity) or [HTTP Archive](https://httparchive.org/).
44+
These are the tests that will be used to score progress in this Focus Area.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Investigation Effort Proposal
2+
description: Proposal for an Interop 2023 Investigation Effort
3+
labels: investigation-effort-proposal
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to make a proposal for Interop 2023!
9+
10+
Please see the [Interop 2023 README](https://github.com/web-platform-tests/interop/blob/main/2023/README.md) for the timeline and what to expect from the process.
11+
12+
**Please make sure you're using the right proposal template!** If this feature has a high quality specification and tests, submit a [Focus Area](https://github.com/web-platform-tests/interop/issues/new?template=focus-area-proposal.yml) proposal instead.
13+
- type: textarea
14+
attributes:
15+
label: Description
16+
description: Brief description of the feature. Try to be clear about what parts of the feature are included and not.
17+
- type: textarea
18+
attributes:
19+
label: Rationale
20+
description: |
21+
Reasons for including the feature. A few dimensions to consider are:
22+
23+
- Web developer sentiment from polls or surveys, for example, [MDN surveys](https://insights.developer.mozilla.org/) or [State of CSS](https://stateofcss.com/).
24+
- Examples of sites or libraries working around a missing feature or browser bug.
25+
- Browser bugs or browser bug statistics, for example, [Chromium](https://bugs.chromium.org/), [Gecko](https://bugzilla.mozilla.org/), or [WebKit](https://bugs.webkit.org/).
26+
- Current usage of the feature, for example, [Chrome use counters](https://www.chromestatus.com/metrics/feature/popularity) or [HTTP Archive](https://httparchive.org/).
27+
- type: textarea
28+
attributes:
29+
label: Investigation Roadmap
30+
description: |
31+
Please describe the steps necessary to get this feature to a state of high quality specification and tests. Link to existing spec and tests, and describe what needs to be done, ideally as a set of distinct tasks. If there are open-ended questions about the behavior that require investigation, try to still capture this as a set of tasks, such as "test existing behavior", "update specification", and "update tests".
32+
33+
Any standards work must be done in the appropriate standards group, and those doing the work need to join those groups. Interop 2023 is not a venue for specifying new features.

2023/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Interop 2023
22

3-
**Interop 2023 has not yet launched and this documentation is still being finalized. Please do not submit proposals yet.**
4-
53
Interop 2023 aims to make the web more interoperable in key areas, prioritized by web developer and user needs. The team is formed of browser vendors and other contributors to the web platform, and is part of [the web-platform-tests project](https://github.com/web-platform-tests/wpt).
64

75
Similar to [Interop 2022](https://wpt.fyi/interop-2022), this will be a public metric based on the progress of selected focus areas and investigation efforts. The overall timeline for the planning process is:
@@ -15,19 +13,20 @@ If you would like to make a proposal or contribute in other ways, read on.
1513

1614
## Making a proposal
1715

18-
**Interop 2023 has not yet launched and this documentation is still being finalized. Please do not submit proposals yet.**
19-
2016
If you've had problems using a feature on the web because of differences between browsers, or because it isn't implemented in all browsers, it may be a good proposal for Interop 2023!
2117

2218
Before making a proposal, here's what to expect:
2319

24-
- Only features which have high quality specifications and tests are in scope. Interop 2023 is not a venue for specifying new features; that work happens in working groups within organizations such as W3C and WHATWG.
20+
- There are two kinds of proposals:
21+
- **Focus Area**: Most proposals should fall into the category, where the goal is for browsers to pass a set of tests for a feature. Only features which have high quality specifications and tests are in scope.
22+
- **Investigation Effort**: If a feature is widely implemented, but lacks a high quality specification or tests, an investigation effort may be appropriate. An investigation efforts consists of a set of tasks that will bring the feature up to the bar required for a Focus Area in the future. If this involves any standards work, that work must be done in the appropriate standards group, and those doing the work need to join those groups.
23+
- Interop 2023 is not a venue for specifying new features; that work happens in working groups within organizations such as W3C and WHATWG.
2524
- Interop 2023 is not a process for making browser vendors work on things they're opposed to. Decisions are made by consensus, so highly contentious features are unlikely to be accepted.
2625
- Even great proposals may ultimately not be accepted, since we have to prioritize.
2726

2827
The process for making and driving a proposal is:
2928

30-
- **September 15 to October 15**: [File a proposal issue](https://github.com/web-platform-tests/interop/issues/new?labels=proposal&template=proposal.yml) and fill in as many details as you can.
29+
- **September 15 to October 15**: Submit your [Focus Area](https://github.com/web-platform-tests/interop/issues/new?template=focus-area-proposal.yml) or [Investigation Effort](https://github.com/web-platform-tests/interop/issues/new?template=investigation-effort-proposal.yml) proposal and fill in as many details as you can.
3130
- **October 16 to October 30**: The Interop team review and discuss proposals. During this time some refinements to the proposal can still be made. After this point no further action is required, but continued participation is certainly welcome, particularly to answer any questions.
3231
- **November 1 to November 30**: The Interop team decide, by consensus, which proposals to accept. Accepted proposals will require a pull request to document the accepted proposal in the repository. Help with this is appreciated, but not required.
3332

@@ -40,7 +39,7 @@ The Interop team is responsible for driving everything after a proposal is accep
4039
- Finalize test selection.
4140
- Complete announcement plans. Prepare dashboard for launch.
4241
- **January 23 to January 27**: Public launch.
43-
- **Throughout 2023**: Track progress on the public dashboard. If issues with the test suite are found, anyone can make [test change proposals](https://github.com/web-platform-tests/interop/issues/new?assignees=&labels=test-change-proposal&template=test-change-proposal.md), for review by the Interop team. Significant changes to the scope are unlikely to be accepted.
42+
- **Throughout 2023**: Track progress on the public dashboard. If issues with the test suite are found, anyone can make [test change proposals](https://github.com/web-platform-tests/interop/issues/new?template=test-change-proposal.yml), for review by the Interop team. Significant changes to the scope are unlikely to be accepted.
4443

4544
Ultimately, the outcome we hope for is that interoperability significantly improves, and that web developers and users benefit.
4645

0 commit comments

Comments
 (0)