Repository files navigation

This repository hosts theWebSockets Standard.

We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect theCode of Conduct.

Folks notice minor and larger issues with the WebSockets 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 WebSockets 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 theFAQ andWorking Mode documents to get yourself familiarized with the process.

We'd be happy to help you with all of thison Chat.

In short, changeindex.bs and submit your patch, with agood 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 theContributor Guidelines. Editors of the WebSockets Standard are expected to follow theMaintainer 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 WebSockets Standard can be found in thewebsockets/ directory ofweb-platform-tests/wpt.

A dashboard showing the tests running against browser engines can be seen atwpt.fyi/results/websockets.

For quick local iteration, runmake; this will use a web service to build the standard, so that you don't have to install anything. See more in theContributor Guidelines.