Skip to content

Commit 235bd69

Browse files
chore: tidy up document (#133)
1 parent 5bdf2a6 commit 235bd69

File tree

4 files changed

+5252
-1652
lines changed

4 files changed

+5252
-1652
lines changed

.travis.yml

+6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
language: node_js
2+
dist: xenial
3+
node_js:
4+
- lts/*
25
branches:
36
only:
47
- gh-pages
@@ -7,7 +10,10 @@ env:
710
- URL="https://w3c.github.io/html-aria/echidna-manifest.txt"
811
- DECISION="https://lists.w3.org/Archives/Public/public-html-admin/2015May/0021.html"
912
- secure: GCoNiJ83LqT6HxuSFPXg0yHBbNxvTVJqzMjubbeU0W+zFUe+C45DoY5EH8tfuNivJbw+SzjoKHYHNSMLsqMaZ9wl1SYkcfbM/HIdkUF6HpXZtxblFCqj7srThSuhbSkzPNodSmwCmjNraKBmqtk95+wl4Ck9wF/d4aFJhyPT4nxtkErIH5fhcJPAeJ9Ui8VuQSrEy9k4VNZU8ylRSoLOSqClHtlpVfhHBITNeoIVzByT6Yp5lwWV4DL8bcCzYnyBLYh2e09POF+tnL/dGkbm5E4GvSFaglZM9mbmb5SLH0y7i21WI7LKtir4G831p1tBQGRejZ/P2e8vgveizsWxWxGL/VrJR9lgJqCjppLmm6rfcKF3lR34PzYRPE+IzJ63HOOysuESKAXq4orCzdP64pooN75JnOQV+baYVJV78abmeA1epGqLOaRcMRreWf/2U+jvzYMqfH7lNP74c82cur9rswfHm14oKhJzbFrJ+CIGO2KqdAlISSm6Hoa7lTARhn5XefmQtSR0hq2q9POmPP5Qo/hH1HeTvriZd1RpeGfEzUAkutUWY19bvAnkxWUlF5PGu0t8zesrn8l54TX4wwHuWeQNoLhU1D0ftnfF6oXH1MmO++EN/qYJAX/QOUY0XO+BV5OU9I0kSJPDuNS6eQBxGrIluNRYXLyhnPdYe0U=
13+
install:
14+
- npm install respec-validator
1015
script:
16+
- npx respec-validator --gh-user=$GH_USER --gh-token=$GH_TOKEN index.html
1117
- echo "Done!"
1218
after_success:
1319
- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && curl "https://labs.w3.org/echidna/api/request" --data "url=$URL" --data "decision=$DECISION" --data "token=$TOKEN"'

CONTRIBUTING.md

+43-8
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
# Web Platform Working Group
1+
# Web Applications Working Group
22

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

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

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

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

23-
If you are making a pull request on behalf of someone else but you had no part in designing the
24+
If you are making a pull request on behalf of someone else but you had no part in designing the
2425
feature, you can remove yourself with the above syntax.
26+
27+
## Tests
28+
29+
For normative changes, a corresponding
30+
[web-platform-tests](https://github.com/web-platform-tests/wpt) PR should be included. Typically,
31+
both PRs will be merged at the same time. Note that a test change that contradicts the spec should
32+
not be merged before the corresponding spec change. If testing is not practical, please explain why
33+
and if appropriate [file an issue](https://github.com/web-platform-tests/wpt/issues/new) to follow
34+
up later. Add the `type:untestable` or `type:missing-coverage` label as appropriate.
35+
36+
## Style guide to contributors
37+
38+
- the spec uses [ReSpec](https://github.com/w3c/respec/wiki)
39+
- the spec is tidied using [HTML5 Tidy](https://github.com/w3c/tidy-html5). For
40+
instructions on running HTML5 tidy, see below.
41+
- put comments in front of sections, for better readability with
42+
syntax coloring editors
43+
44+
## Running HTML5 Tidy
45+
46+
Please make sure you have HTML5 tidy installed, instead of
47+
the the one that ships with \*nix systems. You can confirm this by running:
48+
49+
```bash
50+
tidy --version
51+
#HTML Tidy for [some OS] version...
52+
```
53+
54+
Once you have confirmed (make sure you have committed your changes before
55+
running tidy, as the changes are destructive ... in a good way:)):
56+
57+
```bash
58+
tidy -config tidyconf.txt -o index.html index.html
59+
```

0 commit comments

Comments
 (0)