Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the Interop 2023 proposals process for the public #115

Merged
merged 15 commits into from
Sep 9, 2022
Merged
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/compat-bug-proposal.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Other
about: Any issue that isn't a proposal to include in Interop 2022
about: Any issue that isn't a proposal to include in Interop 2023
title: ''
labels: ''
assignees: ''
Expand Down
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/proposal.md

This file was deleted.

41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Proposal
description: Proposal for feature to include in Interop 2023
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it makes sense to have a separate issue template for investigation proposals, asking for more things like "what is the proposed outcome of this investigation effort, what is being investigated, etc"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we should do that!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We usually use the term "focus area" rather than "feature". I notice that you're using "feature" all the way through here, and I guess a 1:1 mapping is the commonest case, but it's not the general case e.g. webcompat isn't a single feature, and the "Typography and Encodings" focus area from last year wasn't a single feature (although that was a later merge of several proposals).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't make a conscious decision on this, but overall tried to use wording that'd be easier to parse for web developers, written more from the outside than the inside perspective.

I don't have a strong opinion on this one, but do you think it'd be fine to talk about feature (singular) and just let people propose things that aren't strictly a single feature anyway? Or maybe we talk about "feature or group of features"? I think "focus area" might require explanation to be understood.

labels: proposal
body:
- type: markdown
attributes:
value: |
**Interop 2023 has not yet launched and this documentation is still being finalized. Please do not submit proposals yet.**

Thanks for taking the time to make a proposal for Interop 2023!

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.
- type: textarea
attributes:
label: Description
description: Brief description of the feature. Try to be clear about what parts of the feature are included and not.
- type: textarea
attributes:
label: Specification
description: |
Specification for the feature. The feature should be defined by a standards-track specification from the following organizations:

- [IETF](https://www.ietf.org/) (Standard Track)
- [Khronos Group](https://www.khronos.org/)
- [TC39](https://tc39.es/) (Stage 2+)
- [W3C](https://www.w3.org/) (Recommendation Track)
- [WHATWG](https://whatwg.org/)
- type: textarea
attributes:
label: Tests
description: Tests for the feature in web-platform-tests on [wpt.fyi](https://wpt.fyi/), or in Test262 on [test262.report](https://test262.report/).
- type: textarea
attributes:
label: Rationale
description: |
Reasons for including the feature. A few dimensions to consider are:

- Web developer sentiment from polls or surveys, for example, [MDN surveys](https://insights.developer.mozilla.org/) or [State of CSS](https://stateofcss.com/).
- Examples of sites or libraries working around a missing feature or browser bug.
- Browser bugs or browser bug statistics, for example, [Chromium](https://bugs.chromium.org/), [Gecko](https://bugzilla.mozilla.org/), or [WebKit](https://bugs.webkit.org/).
- Current usage of the feature, for example, [Chrome use counters](https://www.chromestatus.com/metrics/feature/popularity) or [HTTP Archive](https://httparchive.org/).
51 changes: 51 additions & 0 deletions 2023/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Interop 2023

**Interop 2023 has not yet launched and this documentation is still being finalized. Please do not submit proposals yet.**

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

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:

- Public call for proposals beginning September 15.
- Proposal review by the team, with an opportunity for refinement.
- Selection of proposals by the team, based on consensus.
- Public launch in early 2023.

If you would like to make a proposal or contribute in other ways, read on.

## Making a proposal

**Interop 2023 has not yet launched and this documentation is still being finalized. Please do not submit proposals yet.**

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!

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

- 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.
- 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.
- Even great proposals may ultimately not be accepted, since we have to prioritize.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this bullet is adding much value, but it does feel like it's adding a lot of stop energy. Maybe it would sound less negative to fold it into the previous bullet point and added some positive advice: ", so highly contentious features are unlikely to be accepted, and vendors will also consider the priority of proposals against other possible work. Proposals accompanied by strong rationale (e.g. evidence of problems affecting real sites, or significant developer interest) are more likely to succeed."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with whatever wording others are happy with here. The purpose of this was to avoid disappointment if we end up not accepting some good proposals from "external" contributors who put in a lot of work.


The process for making and driving a proposal is:

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

## After a proposal is accepted

The Interop team is responsible for driving everything after a proposal is accepted. Here's what to expect:

- **December 1 to December 16**: Detailed review of the tests, and possibly writing some additional tests. Creation of a public dashboard showing the accepted proposals.
- **January 9 to January 20**:
- Finalize test selection.
- Complete announcement plans. Prepare dashboard for launch.
- **January 23 to January 27**: Public launch.
- **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.

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

## Other ways to contribute

TODO

You're also welcome to join the conversation in the [`#interop20xx:matrix.org` Matrix channel](https://app.element.io/#/room/#interop2022:matrix.org)!
32 changes: 3 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,5 @@
# Interop 2022
# The Interop Project

This repository is for discussing proposals relating to the Interop
2022 project.
Welcome to the Interop project, an ongoing effort to make the web more interoperable in key areas, prioritized by web developer and user needs. This is part of [the web-platform-tests project](https://github.com/web-platform-tests/wpt), the main test suite for the web platform.

The overall process and timeline for decision making is given by [wpt
RFC 99](https://github.com/web-platform-tests/rfcs/blob/master/rfcs/interop_2022.md).

For each proposed Interop 2022 focus area:
* First check for an existing issue covering that area. We are aiming
to consolidate discssion for each proposal in a single issue.

* If no issue exists, file a new issue. The issue title should
clearly describe the feature being proposed for inclusion. The body
of the issue should outline the reason for including the issue and should include:

- A link to the relevant specification document

- A link to relevant testcases (assuming they exist)

- Supporting data for including the feature as part of an interop
effort e.g. evidence of significant developer interest in the
feature, or evidence of site breakage caused by implementation
differences in the feature.

- Links to any existing discussion or vendor signals e.g. in browser
project bug trackers.

## Join the discussion

* [Real-time chat room](https://app.element.io/#/room/#interop2022:matrix.org): the `#interop2022:matrix.org` Matrix channel
**We are currently planning for Interop 2023 and welcome participation from anyone working on the web, please see the [Interop 2023 README](./2023/README.md) to learn more!**.