Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 2.17 KB

How to contribute

This repository containes the current Web Audio API standard document, developed by the Audio Working Group at the W3C. There are multiple implementations of the Web Audio API standard.

If you're about to open an issue about a bug in a particular implementation, please file a ticket in the corresponding implementation bug tracker instead:

Testing the same Web Audio API code in multiple implementations can be a quick way to check if an implementation has a bug. However, it has happened that different implementation have the same bug, so it's best to read the standard document, and to check what should happen.

Feature requests are welcome, but a quick search in the opened and closed issues is welcome to avoid duplicates.

Pull requests are also welcome, but any change to the standard (barring things like typos and the like) will have to be discussed in an issue (and possibly during a call, accessible only to W3C Audio Working Group members).

Bikeshed is the tool used to write this specification. It can either be used via an HTTP API, or by running it locally.

To use it via the HTTP API, run:

curl https://api.csswg.org/bikeshed/ -F file=@index.bs -F force=1 -F output=err -o err && cat err | sed -E 's/\\033\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g' | diff -u - expected-errs.txt

and preview your changes by doing:

curl https://api.csswg.org/bikeshed/ -F file=@index.bs -F force=1 > index.html

and opening index.html in your favorite browser.

To run it locally, follow the installation instructions.

Then, bikeshed serve will run a web server locally on port 8000.