Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 2.04 KB

Contribution Details

Joining WICG

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

Editing the specification

Edits to the specification are done in the spec.bs file, which is then compiled with the Bikeshed spec pre-processor.

To build the specification, you can use one of:

  • make local: uses a locally-installed copy of Bikeshed
  • make remote: uses a Bikeshed web service, so you don't have to install anything locally

Reference implementation

We maintain a reference implementation in the reference-implementation/ subfolder. This is currently serving as a prototyping ground before we start working on the formal specification. Eventually we anticipate it co-evolving alongside the specification, in the same was as is done for other standards like Streams, URL, and the MIME type parser.

Tests

This specification is not yet far enough along to have web platform tests. But soon!

In the meantime, unit tests that validate individual algorithms accompany the reference implementation, and should be updated as part of it.

For maintainers: identifying contributors to a pull request

If the author is not the sole contributor to a pull request, please identify all contributors in the pull request comment.

To add a contributor (other than the author, which is 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 the author is making a pull request on behalf of someone else but they had no part in designing the feature, you can remove them with the above syntax.