| OLD | NEW |
| 1 The Web Platform Tests Project [](http://irc.w
3.org/?channels=testing) | 1 The Web Platform Tests Project [](http://irc.w
3.org/?channels=testing) |
| 2 ============================== | 2 ============================== |
| 3 | 3 |
| 4 The Web Platform Tests Project is a W3C-coordinated attempt to build a | 4 The Web Platform Tests Project is a W3C-coordinated attempt to build a |
| 5 cross-browser testsuite for the Web-platform stack. Writing tests in a | 5 cross-browser testsuite for the Web-platform stack. Writing tests in a |
| 6 way that allows them to be run in all browsers gives browser projects | 6 way that allows them to be run in all browsers gives browser projects |
| 7 confidence that they are shipping software that is compatible with other | 7 confidence that they are shipping software that is compatible with other |
| 8 implementations, and that later implementations will be compatible with | 8 implementations, and that later implementations will be compatible with |
| 9 their implementations. This in turn gives Web authors/developers | 9 their implementations. This in turn gives Web authors/developers |
| 10 confidence that they can actually rely on the Web platform to deliver on | 10 confidence that they can actually rely on the Web platform to deliver on |
| (...skipping 154 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 165 | 165 |
| 166 * Fork this repository (and make sure you're still relatively in sync | 166 * Fork this repository (and make sure you're still relatively in sync |
| 167 with it if you forked a while ago). | 167 with it if you forked a while ago). |
| 168 * Create a branch for your changes: | 168 * Create a branch for your changes: |
| 169 `git checkout -b your-name/topic`. | 169 `git checkout -b your-name/topic`. |
| 170 * Make your changes. | 170 * Make your changes. |
| 171 * Run the lint script described below. | 171 * Run the lint script described below. |
| 172 * Commit locally and push that to your repo. | 172 * Commit locally and push that to your repo. |
| 173 * Send in a pull request based on the above. | 173 * Send in a pull request based on the above. |
| 174 | 174 |
| 175 A lint is available to test for common mistakes in testcases. It can | 175 Lint tool |
| 176 be run with: | 176 --------- |
| 177 |
| 178 We have a lint tool for catching common mistakes in test files. You |
| 179 can run it manually by starting the `lint` executable from the root of |
| 180 your local web-platform-tests working directory like this: |
| 177 | 181 |
| 178 ``` | 182 ``` |
| 179 ./lint | 183 ./lint |
| 180 ``` | 184 ``` |
| 181 | 185 |
| 182 in the root of the checkout. It is also run for every submitted pull | 186 The lint tool is also run automatically for every submitted pull |
| 183 request, and branches with lint errors will not get merged. In the | 187 request, and reviewers will not merge branches with tests that have |
| 184 unusual case that the lint is reporting an error for something that is | 188 lint errors, so you must fix any errors the lint tool reports. For |
| 185 essential to your test, there is a whitelist at | 189 details on doing that, see the [lint-tool documentation][lint-tool]. |
| 186 `tools/lint/lint.whitelist` that may be updated. | 190 |
| 191 But in the unusual case of error reports for things essential to a |
| 192 certain test or that for other exceptional reasons shouldn't prevent |
| 193 a merge of a test, update and commit the `lint.whitelist` file in the |
| 194 web-platform-tests root directory to suppress the error reports. For |
| 195 details on doing that, see the [lint-tool documentation][lint-tool]. |
| 196 |
| 197 [lint-tool]: https://github.com/w3c/web-platform-tests/blob/master/docs/lint-too
l.md |
| 187 | 198 |
| 188 Adding command-line scripts ("tools" subdirs) | 199 Adding command-line scripts ("tools" subdirs) |
| 189 --------------------------------------------- | 200 --------------------------------------------- |
| 190 | 201 |
| 191 Sometimes you may want to add a script to the repository that's meant | 202 Sometimes you may want to add a script to the repository that's meant |
| 192 to be used from the command line, not from a browser (e.g., a script | 203 to be used from the command line, not from a browser (e.g., a script |
| 193 for generating test files). If you want to ensure (e.g., for security | 204 for generating test files). If you want to ensure (e.g., for security |
| 194 reasons) that such scripts won't be handled by the HTTP server, but | 205 reasons) that such scripts won't be handled by the HTTP server, but |
| 195 will instead only be usable from the command line, then place them in | 206 will instead only be usable from the command line, then place them in |
| 196 either: | 207 either: |
| (...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 237 [contributing]: https://github.com/w3c/web-platform-tests/blob/master/CONTRIBUTI
NG.md | 248 [contributing]: https://github.com/w3c/web-platform-tests/blob/master/CONTRIBUTI
NG.md |
| 238 [ircw3org]: https://www.w3.org/wiki/IRC | 249 [ircw3org]: https://www.w3.org/wiki/IRC |
| 239 [ircarchive]: http://krijnhoetmer.nl/irc-logs/testing/ | 250 [ircarchive]: http://krijnhoetmer.nl/irc-logs/testing/ |
| 240 [mailarchive]: http://lists.w3.org/Archives/Public/public-test-infra/ | 251 [mailarchive]: http://lists.w3.org/Archives/Public/public-test-infra/ |
| 241 | 252 |
| 242 Documentation | 253 Documentation |
| 243 ============= | 254 ============= |
| 244 | 255 |
| 245 * [How to write and review tests](http://testthewebforward.org/docs/) | 256 * [How to write and review tests](http://testthewebforward.org/docs/) |
| 246 * [Documentation for the wptserve server](http://wptserve.readthedocs.org/en/lat
est/) | 257 * [Documentation for the wptserve server](http://wptserve.readthedocs.org/en/lat
est/) |
| OLD | NEW |