Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 2.58 KB

Web Platform Incubator Community Group

This repository is being used for work in the W3C Web Platform Incubator Community Group, governed by the W3C Community License Agreement (CLA). To make substantive contributions, you must join the CG.

If you are not the sole contributor to a contribution (pull request), please identify all contributors in the pull request comment.

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

+@github_username

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 feature, you can remove yourself with the above syntax.

Specification Development

If you are interested in making changes to the specification, set up this repository on your local machine first. You can follow the instructions on the README.

The source file for the specification document is at src/pages/specification/specification-respec.html. This is the raw ReSpec version that editors should make changes and updates to. Documentation for ReSpec can be accessed on the ReSpec Wiki.

Preview changes with npx http-server ./src/pages/specification/ and opening http://localhost:8080/specification-respec.html . (The Astro dev server interferes with example inclusion.)

Export a static HTML version of the specification when your changes are done with src/pages/specification/respec.sh. (You may need to install tidy with brew install tidy-html5.)

In general, Community Group Draft Reports do not follow the same strict conventions as more mature specifications. We only archive major versions of the specification. For example, a copy of the 2021-03-17 draft report currently lives in src/pages/specification/versions/.

Prettier is disabled on src/pages/specification as it conflicts with the code format style used by W3C specifications. There is no way to configure Prettier to follow the W3C recommendation of not using trailing slashes on void elements.