This repository hosts the Streams Standard.
Folks notice minor and larger issues with the Streams Standard all the time and we'd love your help fixing those. Pull requests for typographical and grammar errors are also most welcome.
We'd be happy to mentor you through this process. If you're interested and need help getting started, leave a comment on the issue or ask around on IRC.
Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically.
For formatting specific to this standard, see CONTRIBUTING.md. Additionally, for any normative changes, we'll also want to change the tests and reference implementation:
Tests can be found in the
streams/ directory of
reference-implementation/. See the README under that directory for more details.
We strive for every commit that changes the spec to also add tests, and to change the reference implementation in order to pass those tests.
This standard requires a recent version of Node.js to be installed as a
prerequisite. Once that's done, you'll need to do a one-time run of
npm install to set up our
For quick local iteration, run
make. To verify your changes locally, run
make deploy. See more
WHATWG Contributor Guidelines.
If you can commit to this repository, see the WHATWG Maintainer Guidelines.
Code of conduct
We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect the WHATWG Code of Conduct.