This repository hosts the Compression Standard.
We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect the Code of Conduct.
Folks notice minor and larger issues with the Compression Standard all the time and we'd love your help fixing those. Pull requests for typographical and grammar errors are also most welcome.
Issues labeled "good first issue" are a good place to get a taste for editing the Compression Standard. Note that we don't assign issues and there's no reason to ask for availability either, just provide a pull request.
If you are thinking of suggesting a new feature, read through the FAQ and Working Mode documents to get yourself familiarized with the process.
We'd be happy to help you with all of this on Chat.
In short, change index.bs and submit your patch, with a good commit message.
Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically.
To ensure your patch meets all the necessary requirements, please also see the Contributor Guidelines. Editors of the Compression Standard are expected to follow the Maintainer Guidelines.
Tests are an essential part of the standardization process and will need to be created or adjusted as changes to the standard are made. Tests for the Compression Standard can be found in the compression/ directory of web-platform-tests/wpt.
A dashboard showing the tests running against browser engines can be seen at wpt.fyi/results/compression.
For quick local iteration, run make; this will use a web service to build the standard, so that you don't have to install anything. See more in the Contributor Guidelines.