src/third_party/WebKit/LayoutTests/w3c/web-platform-tests/README.md

   1 Description
   2 ===========
   3
   4 This is the test suites from a number of W3C Working Groups, including the HTML
   5 Working Group, the Web Apps Working Group, the Device APIs Working Group, and
   6 the Web Apps Security Working Group.
   7
   8 Publication
   9 ===========
  10
  11 The master branch is automatically synced to: http://w3c-test.org/web-platform-tests/master/.
  12 Likewise the CR branch (that matches the test suites used for the Candidate
  13 Recommendations of HTML5, Canvas 2D and Microdata) to: http://w3c-test.org/web-platform-tests/CR/.
  14
  15 Pull requests that have been checked are automatically mirrored to
  16 https://w3c-test.org/web-platform-tests/submissions/
  17
  18 Finding Things
  19 ==============
  20 Each top-level directory represents a W3C specification: the name matches the
  21 shortname used after the canonical address of the said specification under
  22 http://www.w3.org/TR/ .
  23
  24 For some of the specifications, the tree under the top-level directory
  25 represents the sections of the respective documents, using the section IDs for
  26 directory names, with a maximum of three levels deep.
  27
  28 So if you're looking for tests in HTML for "The History interface",
  29 they will be under `html/browsers/history/the-history-interface/`.
  30
  31 Various resources that tests depend on are in `common`, `images`, and `fonts`.
  32
  33 In order to function properly, tests need to be run from a web server that has
  34 [testharness.js](https://github.com/w3c/testharness.js) in `/resources/`.
  35
  36 If you're looking at a section of the specification and can't figure out where
  37 the directory is for it in the tree, just run:
  38     node tools/scripts/id2path.js your-id
  39
  40 Branches
  41 ========
  42
  43 In the vast majority of cases the **only** branch that you should need to care
  44 about is `master`.
  45
  46 There is another branch called `CR`. This is a strict subset of `master` that
  47 is limited to features that are found in the Candidate Recommendation version
  48 of the relevant specifications.
  49
  50 If you see other branches in the repository, you can generally safely ignore
  51 them. Please note that branches prefixed with `temp/` are temporary branches
  52 and **can** get deleted at some point. So don't base any work off them unless
  53 you want to see your work destroyed.
  54
  55 Contributing
  56 ============
  57
  58 Save the Web, Write Some Tests!
  59
  60 Absolutely everyone is welcome (and even encouraged) to contribute to test
  61 development, so long as you fulfill the contribution requirements detailed
  62 in the [Contributing Guidelines][contributing]. No test is too small or too
  63 simple, especially if it corresponds to something for which you've noted an
  64 interoperability bug in a browser.
  65
  66 The way to contribute is just as usual:
  67
  68 * fork this repository (and make sure you're still relatively in sync with it
  69   if you forked a while ago);
  70 * create a branch for your changes, `git checkout -b submission/your-name`;
  71 * make your changes;
  72 * push that to your repo;
  73 * and send in a pull request based on the above.
  74
  75 Please make your pull requests either to `master` or to a feature branch
  76 (but not to `CR`).
  77
  78 We can sometimes take a little while to go through pull requests because
  79 we have to go through all the tests and ensure that they match the specification
  80 correctly. But we look at all of them, and take everything that we can.
  81
  82 If you wish to contribute actively, you're very welcome to join the
  83 public-html-testsuite@w3.org mailing list (low traffic) by
  84 [signing up to our mailing list](mailto:public-html-testsuite-request@w3.org?subject=subscribe).
  85
  86 [contributing]: https://github.com/w3c/web-platform-tests/blob/master/CONTRIBUTING.md