mdn / mdn/browser-compat-data

Require bug link for partial implementation

Open
#28,374 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

linter
Dominant language
JSON
Stars
5.8k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
186

Description

What type of issue is this?

Linter issue

What is the issue?

When a browser is marked as partially supporting a feature, we don't currently require a bug link, making it hard to check if the limitation was meanwhile resolved.

What behavior were you expecting?

For every support statement with partial_implementation: true, we should require a bug link, either in the notes (preferred) or in the impl_url.

What version(s) of BCD is the issue present in?
  • The current BCD release
  • The current version of the main branch
Do you have anything more you want to share?

The following Firefox support statement for css.selectors.highlight prompted this:

https://github.com/mdn/browser-compat-data/blob/9ec9ff9b03e756da2b1b906c9ef00334775453aa/css/selectors/highlight.json#L21-L25

Requiring a bug link would provide context, make it easier to check if the limitation is still valid, and identify the browser version in which it was fixed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading css/selectors/highlight.json, especially the Firefox support statement cited in the issue, then locate the linter rule that validates support statements. Done means every statement with partial_implementation: true is rejected unless a bug link appears in notes or impl_url, with notes preferred.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.