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.

Sign up for GitHub

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

Jump to bottom

Contributor docs: loosen restrictions on caniuse correspondence #1915

Merged
merged 3 commits into from
Oct 14, 2024
Merged

Contributor docs: loosen restrictions on caniuse correspondence #1915

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7153026
Contributor docs: loosen restrictions on caniuse correspondence
ddbeck Oct 7, 2024
ed46c1f
Turn amelioration options into a list
ddbeck Oct 14, 2024
8aeb22b
Revise caniuse-status reconciliation text
ddbeck Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions docs/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,17 +260,17 @@ Follow these guidelines when setting a `caniuse` value:
- Do not set a `caniuse` value if the Can I Use feature is merely related to the feature.
For example, in [`grid.yml`](../features/grid.yml), do not set `caniuse: css-subgrid`.

- Do not set a `caniuse` value if the top-level headline `status` would not be accurate with respect to the table on Can I Use.
For example, if Can I Use shows that a core browser set browser does not support a feature but web-features's status reports that the feature is Baseline high, then do not set the `caniuse` value for that feature.
- Do not set a `caniuse` value if the top-level headline `status` does not match Can I Use on whether each browser supports or does not support the feature.

- Do not set a `caniuse` value if the top-level headline status's first-supported release (for example, the value of `status.support.safari`) differs from Can I Use's first-supported release by:
For example, if Can I Use shows that one browser of the core browser set does not support a feature but web-features's status reports that the feature is supported across all of the browsers, then do one of these:

- More than one release for releases since 2020
- More than one year for releases before 2020
- Do not set the `caniuse` value for that feature.
- Submit a correction to Can I Use.
- Submit a correction to mdn/browser-compat-data.

This means there's a major disagreement—and a likely error—in mdn/browser-compat-data or Can I Use.
- Do not set a `caniuse` value if the top-level headline `status` would not accurately reflect when a feature was last introduced to core browser set (the [keystone release](./baseline.md#interoperable-low-status) version number).

If you see a discrepancy between Can I Use and a computed status that is less than one year for releases before 2020, please make a note of it in [#1499](https://github.com/web-platform-dx/web-features/issues/1499).
For example, if Can I Use shows that Edge 79 introduced a feature, then the headline status must also show that Edge 79 introduced the feature.

- Do use `compute_from` to improve the correspondence of a feature's top-level headline status with Can I Use data.
Use this in cases where later additions, such as the introduction of a minor property or method, brings the statuses out of alignment.
Expand All @@ -280,6 +280,10 @@ Follow these guidelines when setting a `caniuse` value:
Don't use `compute_from` in a way that would not make sense if the corresponding `caniuse` value didn't exist (for example, by pinning support before the introduction of an essential component of the feature).
In such situations, it's better to comment out the `caniuse` value, make a `TODO` comment, and open an issue about why you did it.

If you see a discrepancy between Can I Use and a computed status that is less than one year for releases before 2020, please make a note of it in [#1499](https://github.com/web-platform-dx/web-features/issues/1499).

See also: [#1880](https://github.com/web-platform-dx/web-features/issues/1880).

## Groups

The `group` field references one or more groups.
Expand Down