Skip to content

Commit

Permalink
chore: tidy up document (#133)
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoscaceres committed May 21, 2019
1 parent 5bdf2a6 commit 235bd69
Show file tree
Hide file tree
Showing 4 changed files with 5,252 additions and 1,652 deletions.
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
language: node_js
dist: xenial
node_js:
- lts/*
branches:
only:
- gh-pages
Expand All @@ -7,7 +10,10 @@ env:
- URL="https://w3c.github.io/html-aria/echidna-manifest.txt"
- DECISION="https://lists.w3.org/Archives/Public/public-html-admin/2015May/0021.html"
- secure: GCoNiJ83LqT6HxuSFPXg0yHBbNxvTVJqzMjubbeU0W+zFUe+C45DoY5EH8tfuNivJbw+SzjoKHYHNSMLsqMaZ9wl1SYkcfbM/HIdkUF6HpXZtxblFCqj7srThSuhbSkzPNodSmwCmjNraKBmqtk95+wl4Ck9wF/d4aFJhyPT4nxtkErIH5fhcJPAeJ9Ui8VuQSrEy9k4VNZU8ylRSoLOSqClHtlpVfhHBITNeoIVzByT6Yp5lwWV4DL8bcCzYnyBLYh2e09POF+tnL/dGkbm5E4GvSFaglZM9mbmb5SLH0y7i21WI7LKtir4G831p1tBQGRejZ/P2e8vgveizsWxWxGL/VrJR9lgJqCjppLmm6rfcKF3lR34PzYRPE+IzJ63HOOysuESKAXq4orCzdP64pooN75JnOQV+baYVJV78abmeA1epGqLOaRcMRreWf/2U+jvzYMqfH7lNP74c82cur9rswfHm14oKhJzbFrJ+CIGO2KqdAlISSm6Hoa7lTARhn5XefmQtSR0hq2q9POmPP5Qo/hH1HeTvriZd1RpeGfEzUAkutUWY19bvAnkxWUlF5PGu0t8zesrn8l54TX4wwHuWeQNoLhU1D0ftnfF6oXH1MmO++EN/qYJAX/QOUY0XO+BV5OU9I0kSJPDuNS6eQBxGrIluNRYXLyhnPdYe0U=
install:
- npm install respec-validator
script:
- npx respec-validator --gh-user=$GH_USER --gh-token=$GH_TOKEN index.html
- echo "Done!"
after_success:
- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && curl "https://labs.w3.org/echidna/api/request" --data "url=$URL" --data "decision=$DECISION" --data "token=$TOKEN"'
51 changes: 43 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Web Platform Working Group
# Web Applications Working Group

Contributions to this repository are intended to become part of Recommendation-track documents governed by the
[W3C Patent Policy](http://www.w3.org/Consortium/Patent-Policy-20040205/) and
[Software and Document License](http://www.w3.org/Consortium/Legal/copyright-software). To make substantive contributions to specifications, you must either participate
in the relevant W3C Working Group or make a non-member patent licensing commitment.
Contributions to this repository are intended to become part of Recommendation-track documents
governed by the [W3C Patent Policy](http://www.w3.org/Consortium/Patent-Policy/) and
[Document License](http://www.w3.org/Consortium/Legal/copyright-documents). To contribute, you must
either participate in the relevant W3C Working Group or make a non-member patent licensing
commitment.

If you are not the sole contributor to a contribution (pull request), please identify all
contributors in the pull request comment.
If you are not the sole contributor to a contribution (pull request), please identify all
contributors in the pull request's body or in subsequent comments.

To add a contributor (other than yourself, that's automatic), mark them one per line as follows:

Expand All @@ -20,5 +21,39 @@ If you added a contributor by mistake, you can remove them in a comment with:
-@github_username
```

If you are making a pull request on behalf of someone else but you had no part in designing the
If you are making a pull request on behalf of someone else but you had no part in designing the
feature, you can remove yourself with the above syntax.

## Tests

For normative changes, a corresponding
[web-platform-tests](https://github.com/web-platform-tests/wpt) PR should be included. Typically,
both PRs will be merged at the same time. Note that a test change that contradicts the spec should
not be merged before the corresponding spec change. If testing is not practical, please explain why
and if appropriate [file an issue](https://github.com/web-platform-tests/wpt/issues/new) to follow
up later. Add the `type:untestable` or `type:missing-coverage` label as appropriate.

## Style guide to contributors

- the spec uses [ReSpec](https://github.com/w3c/respec/wiki)
- the spec is tidied using [HTML5 Tidy](https://github.com/w3c/tidy-html5). For
instructions on running HTML5 tidy, see below.
- put comments in front of sections, for better readability with
syntax coloring editors

## Running HTML5 Tidy

Please make sure you have HTML5 tidy installed, instead of
the the one that ships with \*nix systems. You can confirm this by running:

```bash
tidy --version
#HTML Tidy for [some OS] version...
```

Once you have confirmed (make sure you have committed your changes before
running tidy, as the changes are destructive ... in a good way:)):

```bash
tidy -config tidyconf.txt -o index.html index.html
```
Loading

0 comments on commit 235bd69

Please sign in to comment.