Skip to content

Commit

Permalink
Meta: require web-platform-tests for normative changes
Browse files Browse the repository at this point in the history
Part of #1849.
  • Loading branch information
foolip committed Oct 3, 2016
1 parent 6f2c0e8 commit d9b1c54
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,15 @@ The HTML Standard is quite complex and people notice minor and larger issues wit

We label [good first bugs](https://github.com/whatwg/html/labels/good%20first%20bug) that you could help us fix, to get a taste for how to submit pull requests, how the build process works, and so on.

We'd be happy to mentor you through this process. If you're interested and need help getting started, leave a comment on the issue or bug, or ask around [on IRC](https://wiki.whatwg.org/wiki/IRC).
We'd be happy to mentor you through this process. If you're interested and need help getting started, leave a comment on the issue or bug, or ask around [on IRC](https://wiki.whatwg.org/wiki/IRC). The [WHATWG FAQ](https://wiki.whatwg.org/wiki/FAQ) may also be helpful.

### Pull requests

In short, change `source` and submit your patch, with a [good commit message](https://github.com/erlang/otp/wiki/Writing-good-commit-messages). Consider reading through the [WHATWG FAQ](https://wiki.whatwg.org/wiki/FAQ) if you are new here.
In short, change `source` and submit your patch, with a [good commit message](https://github.com/erlang/otp/wiki/Writing-good-commit-messages).

When creating your pull request, notice the **Allow edits from maintainers** option in the GitHub **Create pull request** form, as shown in the following image.
For normative changes, include a link to a [web-platform-tests](https://github.com/w3c/web-platform-tests) PR testing the new behavior. Both PRs will be merged at the same time.

![The "Allow edits from maintainers" checkbox](https://cloud.githubusercontent.com/assets/118412/18292613/01fa90ba-7443-11e6-952f-a35a34d07c62.png)

For minor changes such as simple typo fixes, time can be saved if reviewers (the HTML Standard maintainers) just make the edits directly on your pull-request branch rather than needing to write review comments asking you make the edits. Leaving the **Allow edits from maintainers** option enables that. For more details, see [Improving collaboration with forks](https://github.com/blog/2247-improving-collaboration-with-forks) in the GitHub Blog.
Leave the **Allow edits from maintainers** option enabled to allow reviewers (the HTML Standard maintainers) to fix trivial issues directly on your branch rather than needing to write review comments asking you make the edits. For more details, see [Improving collaboration with forks](https://github.com/blog/2247-improving-collaboration-with-forks) in the GitHub Blog.

Please add your name to the Acknowledgements section (search for `<!-- ACKS`) in your first pull request, even for trivial fixes. The names are sorted lexicographically.

Expand Down Expand Up @@ -68,4 +66,4 @@ End tags must not be omitted (except where it is consistent to do so) and attrib

### Tests

Tests can be found in the `html/` directory of the [web-platform-tests repository](https://github.com/w3c/web-platform-tests).
Tests are in the `html/` directory of [web-platform-tests](https://github.com/w3c/web-platform-tests).
2 changes: 1 addition & 1 deletion TEAM.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This document contains info used by the team maintaining the standard. Mostly bo

Each change needs to result in a single commit on the master branch, with no merge commits. The green squash and merge button is OK to use, but be sure to tidy up the commit message per [guidelines for writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages).

For optimal merges, the following instructions may be helpful:
For normative changes, ensure that there is a [web-platform-tests](https://github.com/w3c/web-platform-tests) PR and merge it together with the spec change. Running the test in some browser is a good idea, but is not required of the PR author.

### Fetching and reviewing pull requests from forks

Expand Down

0 comments on commit d9b1c54

Please sign in to comment.