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

[docs] Document structure of META.yml files #18434

Merged
merged 3 commits into from Sep 3, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/reviewing-tests/index.md
Expand Up @@ -46,10 +46,10 @@ collaborator before it can be merged.

## Notifications

META.yml files are used only to indicate who should be notified of pull
META.yml files are used to indicate who should be notified of pull
requests. If you are interested in receiving notifications of proposed
changes to tests in a given directory, feel free to add yourself to the
META.yml file.
changes to tests in a given directory, feel free to add your GitHub account
username to the `suggested_reviewers` list in the META.yml file.

## Finding contributions to review

Expand Down
7 changes: 7 additions & 0 deletions docs/test-suite-design.md
Expand Up @@ -32,6 +32,13 @@ For example, tests in HTML for ["The History
interface"](https://html.spec.whatwg.org/multipage/history.html#the-history-interface)
are located in `html/browsers/history/the-history-interface/`.

Many directories also include a file named `META.yml`. This file may define any
of the following properties:

- `spec` - a link to the specification covered by the tests in the directory
- `suggested_reviewers` - a list of GitHub account namesuser belonging to
gsnedders marked this conversation as resolved.
Show resolved Hide resolved
people who are notified when pull requests modify files in the directory

Various resources that tests depend on are in `common`, `images`, `fonts`,
`media`, and `resources`.

Expand Down