web-platform-tests / web-platform-tests/rfcs

Guidelines for associating tests with features

Open
#194 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
110
Forks
90
PR merge metrics
No merged PRs in 30d

Description

In https://github.com/web-platform-tests/rfcs/blob/master/rfcs/web_features.md we introduced the ability to associate tests with features using WEB_FEATURES.yml files, and showing them on wpt.fyi like this:

There are now over 150 features mapped using WEB_FEATURES.yml files. To allow more people to contribute to this, it's clear that some guidelines will be needed.

Questions and tentative answers:

  • When should a test be linked to a feature?
    • When it's in the scope of the feature in web-features judging by its description and compat_features list.
    • Tests should match the spec, but contributors aren't expected to verify this, assume the initial review covered this. If it becomes known that a test doesn't match the spec, the best course of action is probably to make it tentative.
  • Can a test be linked to multiple features?
    • Yes! But this is only useful when two features ship in different orders in different browsers, to allow filtering out tests that cover a yet-to-be-implemented feature.
  • How can a specific test be excluded?
    • There's no syntax for this, but the need is obvious. Right now the only way is to list all tests and remove some.
  • What about tentative tests?
    • It's fine if they're captured by the patterns, they can be excluded using !is:tentative on wpt.fyi if desired.
  • What about subtests?
    • There's no way to associate only a few subtests with a feature. This hasn't been a big problem in practice, but in a few cases this makes it impossible to capture all the tests.

Beyond this, some form of test suite review by feature experts would be useful, but I'll file a separate issue about that when I've thought through which repo it belongs in.

cc @jcscottiii

Contributor guide

No contributing guide indexed for this repository

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 rfcs/web_features.md and reviewing existing WEB_FEATURES.yml files, then use the questions and tentative answers in this issue to identify the guidance that is still missing. Done means adding agreed guidelines for associating tests with features, including multiple features, exclusions, tentative tests, and subtests.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.