Skip to content

Commit a6b0e5a

Browse files
author
Marcos Cáceres
committed
chore(CONTRIBUTING.md): update contributing
1 parent c7a9668 commit a6b0e5a

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
# Web Platform Working Group
2-
1+
# Contributing
32
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
3+
[W3C Patent Policy](http://www.w3.org/Consortium/Patent-Policy/) and
54
[Software and Document License](http://www.w3.org/Consortium/Legal/copyright-software). To make substantive contributions to specifications, you must either participate
65
in the relevant W3C Working Group or make a non-member patent licensing commitment.
76

8-
If you are not the sole contributor to a contribution (pull request), please identify all
7+
If you are not the sole contributor to a contribution (pull request), please identify all
98
contributors in the pull request comment.
109

1110
To add a contributor (other than yourself, that's automatic), mark them one per line as follows:
@@ -20,14 +19,36 @@ If you added a contributor by mistake, you can remove them in a comment with:
2019
-@github_username
2120
```
2221

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

26-
# Tests
27-
25+
## Tests
2826
For normative changes, a corresponding
2927
[web-platform-tests](https://github.com/web-platform-tests/wpt) PR is highly appreciated. Typically,
3028
both PRs will be merged at the same time. Note that a test change that contradicts the spec should
3129
not be merged before the corresponding spec change. If testing is not practical, please explain why
3230
and if appropriate [file a web-platform-tests issue](https://github.com/web-platform-tests/wpt/issues/new)
3331
to follow up later. Add the `type:untestable` or `type:missing-coverage` label as appropriate.
32+
33+
# Style guide to contributors
34+
35+
- the spec uses [ReSpec](https://www.w3.org/respec/)
36+
- the spec is tidied using [HTML5 Tidy](https://github.com/w3c/tidy-html5). For
37+
instructions on running HTML5 tidy, see below.
38+
- put comments in front of sections, for better readability with
39+
syntax coloring editors.
40+
41+
# Running HTML5 Tidy
42+
43+
Please make sure you have HTML5 tidy installed, instead of
44+
the the one that ships with *nix systems. You can comfirm this by running:
45+
46+
```bash
47+
tidy --version #HTML Tidy for HTML5 (experimental) for ...
48+
```
49+
Once you have confirmed (make sure you have committed your changes before
50+
running tidy, as the changes are destructive ... in a good way:)):
51+
52+
```bash
53+
tidy -config tidyconfig.txt -o index.html index.html
54+
```

0 commit comments

Comments
 (0)