mdn / mdn/browser-compat-data

Alert reviewers when most but not all keys with the same web-features tag are modified in a PR

Open
#30,483 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This implies that html.elements.meta.name.responsive-embedded-sizing should be unflagged too.

I found this by checking the list of keys in web-features frame-sizing (source, dist) against the PR description, to see if I had the right keys there. It'd be… interesting to use web-features tags to do something like generate automatic review annotations like, "80% of the keys in web-features entry X changed, but not keys A, B, and C. Maybe you should review that?"

Originally posted by @ddbeck in https://github.com/mdn/browser-compat-data/pull/30429#discussion_r3988363146

And now to spell this out more explicitly. In that PR, the following keys were modified:

  • api.Window.requestResize
  • css.properties.frame-sizing
  • css.properties.frame-sizing.auto
  • css.properties.frame-sizing.content-block-size
  • css.properties.frame-sizing.content-height
  • css.properties.frame-sizing.content-inline-size
  • css.properties.frame-sizing.content-width

All of those keys were known to the web-features entry frame-sizing. But the one other key attached to the same feature, html.elements.meta.name.responsive-embedded-sizing, was not modified.

It seems to me that it might be practical to automatically advise reviewers of data relationships like this. Even something rather general, along the lines of a "This PR modifies 88% of [link to feature entry on the explorer]" comment might be quite useful.

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 with the linked web-platform-dx/web-features frame-sizing.yml and frame-sizing.yml.dist entries, then investigate how pull requests in this repository are checked and annotated. Done means reviewers receive a useful warning when most, but not all, keys associated with a web-features entry are modified, including the omitted keys or feature link.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.