src/third_party/WebKit/LayoutTests/imported/csswg-test/README.md

   1 W3C CSS Test Suite Repository
   2 -----------------------------
   3
   4 This repository contains top level directories for all of CSS specs for
   5 which we currently have tests. Place tests in the appropriate directory based
   6 on the first rel="help" link in the test. If you are writing tests for a spec
   7 and it doesn't yet have a directory here, feel free to create it.
   8
   9 There are a few directories that do not map to specifications:
  10
  11 support/ contains common image files to which many of the tests link in
  12 this location
  13
  14 tools/ is random scripts that may be useful when administering tests.
  15
  16 vendor-imports/ is where third parties may import their tests that originate
  17 and are maintained in an external repo. Files in this directory should
  18 never be modified in this repo, but should go through the vendor's process
  19 to be imported here.
  20
  21 work-in-progress/ is a legacy directory that contains all the work that was
  22 once submitted to the repo, but was not yet ready for review. Since the CSSWG
  23 has adopted the GitHub pull request process, no new files should be landed here.
  24 The subdirectories here are named by test author or contributing organization.
  25
  26 Linking Your Tests to Specifications
  27 -----------------------------------
  28
  29 In addition to placing your tests in the appropriate directory in this repository,
  30 you must also include at least one specification link in the test metadata,
  31 following [these guidelines][speclinks].
  32
  33 For CSS tests, you must also be sure you’re linking to a specific level of the spec,
  34 generally the first level where the feature being tested is defined. Where possible,
  35 it’s preferable to link to the official version of the spec, which will start with
  36 http://www.w3.org/TR/. This can usually be found as the ‘Latest version’ link in the
  37 spec itself and will include the level of the spec in the URL. For example, the proper
  38 link to level 1 of the CSS Flexbox spec is:
  39
  40 http://www.w3.org/TR/css-flexbox-1/#RELEVANT_SECTION
  41
  42 When testing features not yet available in an official draft, link to the appropriate
  43 Editor’s Draft found at http://dev.w3.org/csswg/. Be sure to include the level of the
  44 specification in the link. For example, the proper link to the CSS Flexbox Level 1
  45 Editor’s Draft is:
  46
  47 http://dev.w3.org/csswg/css-flexbox-1/#RELEVANT_SECTION
  48
  49 Contributing
  50 -------------
  51
  52 Absolutely everyone is welcome (and even encouraged) to contribute to test
  53 development, so long as you fulfill the contribution requirements detailed
  54 in the [Contributing Guidelines][contributing]. No test is too small or too
  55 simple, especially if it corresponds to something for which you've noted an
  56 interoperability bug in a browser.
  57
  58 Write Access
  59 ------------
  60
  61 This section only applies if you have cloned the repository from
  62 Mercurial. If you've cloned it from GitHub, which is a mirror of
  63 the canonical Mercurial repo, you can submit your tests via a [pull request][github101].
  64
  65 To gain write access to this Mercurial repository, sign up for an account
  66 on the CSS Test Suite Manager (aka Shepherd) at:
  67 https://test.csswg.org/shepherd/register
  68 and then submit a request on the Repository Access page at:
  69 https://test.csswg.org/shepherd/account/access/
  70
  71 You will be notified by email when your request is processed.
  72
  73 Please note that although we will grant write access directly to the Mercurial
  74 repo, it is strongly advised to use GitHub for test submissions to enable
  75 reviewers to use its built-in review tools. Direct submissions to Mercurial
  76 should be limited to administrative or housekeeping tasks, very minor changes
  77 that don't require a review, or from advanced users of the system.
  78
  79 [contributing]: https://github.com/rhauck/csswg-test/blob/master/CONTRIBUTING.md
  80 [github101]: http://testthewebforward.org/docs/github-101.html
  81 [speclinks]: http://testthewebforward.org/docs/test-templates.html#specification-links