Skip to content

Commit f4a7f7f

Browse files
committed
Meta: add a README
1 parent 900a7c8 commit f4a7f7f

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# WebSockets Standard
2+
3+
This repository hosts the
4+
[WebSockets Standard](https://websockets.spec.whatwg.org/).
5+
6+
## Code of conduct
7+
8+
We are committed to providing a friendly, safe, and welcoming environment for all. Please read and
9+
respect the [WHATWG Code of Conduct](https://whatwg.org/code-of-conduct).
10+
11+
## Contribution opportunities
12+
13+
Folks notice minor and larger issues with the WebSockets Standard all the time and we'd love your
14+
help fixing those. Pull requests for typographical and grammar errors are also most welcome.
15+
16+
We'd be happy to mentor you through this process. If you're interested and need help getting
17+
started, leave a comment on the issue or ask around [on chat](https://whatwg.org/chat).
18+
19+
## Pull requests
20+
21+
In short, change `undex.bs` and submit your patch, with a
22+
[good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md). Consider
23+
reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here.
24+
25+
Please add your name to the Acknowledgments section in your first pull request, even for trivial
26+
fixes. The names are sorted lexicographically.
27+
28+
## Building "locally"
29+
30+
For quick local iteration, run `make`. To verify your changes locally, run `make deploy`. See more
31+
in the
32+
[WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md#building).
33+
34+
## Merge policy
35+
36+
If you can commit to this repository, see the
37+
[WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
38+
39+
## Tests
40+
41+
Tests can be found in the `websockets/` directory of
42+
[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).

0 commit comments

Comments
 (0)