Skip to content

Commit 76b79e8

Browse files
authored
Meta: update repository files
See https://github.com/whatwg/spec-factory for details.
1 parent 5c9cc9e commit 76b79e8

File tree

6 files changed

+75
-30
lines changed

6 files changed

+75
-30
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: New issue
2+
description: File a new issue against the WebSockets Standard.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Before filling out this form, please familiarize yourself with the [Code of Conduct](https://whatwg.org/code-of-conduct). You might also find the [FAQ](https://whatwg.org/faq) and [Working Mode](https://whatwg.org/working-mode) useful.
8+
9+
If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
10+
- type: textarea
11+
attributes:
12+
label: "What is the issue with the WebSockets Standard?"
13+
validations:
14+
required: true
15+
- type: markdown
16+
attributes:
17+
value: "Thank you for taking the time to improve the WebSockets Standard!"
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: New feature
2+
description: Request a new feature in the WebSockets Standard.
3+
labels: ["addition/proposal", "needs implementer interest"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before filling out this form, please familiarize yourself with the [Code of Conduct](https://whatwg.org/code-of-conduct), [FAQ](https://whatwg.org/faq), and [Working Mode](https://whatwg.org/working-mode). They help with setting expectations and making sure you know what is required. The FAQ ["How should I go about proposing new features to WHATWG standards?"](https://whatwg.org/faq#adding-new-features) is especially relevant.
9+
10+
If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
11+
- type: textarea
12+
attributes:
13+
label: "What problem are you trying to solve?"
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: "What solutions exist today?"
19+
- type: textarea
20+
attributes:
21+
label: "How would you solve it?"
22+
- type: textarea
23+
attributes:
24+
label: "Anything else?"
25+
- type: markdown
26+
attributes:
27+
value: "Thank you for taking the time to improve the WebSockets Standard!"

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Chat
4+
url: https://whatwg.org/chat
5+
about: Please do reach out with questions and feedback!
6+
- name: Stack Overflow
7+
url: https://stackoverflow.com/
8+
about: If you're having trouble building a web page, this is not the right repository. Consider asking your question on Stack Overflow instead.

.github/workflows/build.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,14 @@ on:
99
jobs:
1010
build:
1111
name: Build
12-
runs-on: ubuntu-20.04
12+
runs-on: ubuntu-22.04
1313
steps:
1414
- uses: actions/checkout@v3
1515
with:
1616
fetch-depth: 2
17-
# Note: `python` will also be this version, which various scripts depend on.
18-
- uses: actions/setup-python@v3
17+
- uses: actions/setup-python@v4
1918
with:
20-
python-version: "3.10"
19+
python-version: "3.11"
2120
# Note: `make deploy` will do a deploy dry run on PRs.
2221
- run: make deploy
2322
env:

PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
<!--
22
Thank you for contributing to the WebSockets Standard! Please describe the change you are making and complete the checklist below if your change is not editorial.
3+
When editing this comment after the PR is created, check that PR-Preview doesn't overwrite your changes.
4+
If you think your PR is ready to land, please double-check that the build is passing and the checklist is complete before pinging.
35
-->
46

57
- [ ] At least two implementers are interested (and none opposed):
68
*
79
*
810
- [ ] [Tests](https://github.com/web-platform-tests/wpt) are written and can be reviewed and commented upon at:
9-
*
11+
* <!-- If these tests are tentative, link a PR to make them non-tentative. -->
1012
- [ ] [Implementation bugs](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) are filed:
1113
* Chromium: …
1214
* Gecko: …
1315
* WebKit: …
1416
* Deno: …
1517
- [ ] [MDN issue](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) is filed: …
18+
- [ ] The top of this comment includes a [clear commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md) to use. <!-- If you created this PR from a single commit, Github copied its message. Otherwise, you need to add a commit message yourself. -->
1619

1720
(See [WHATWG Working Mode: Changes](https://whatwg.org/working-mode#changes) for more details.)

README.md

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,33 @@
1-
# WebSockets Standard
2-
3-
This repository hosts the
4-
[WebSockets Standard](https://websockets.spec.whatwg.org/).
1+
This repository hosts the [WebSockets Standard](https://websockets.spec.whatwg.org/).
52

63
## Code of conduct
74

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).
5+
We are committed to providing a friendly, safe, and welcoming environment for all. Please read and respect the [Code of Conduct](https://whatwg.org/code-of-conduct).
106

117
## Contribution opportunities
128

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.
9+
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.
10+
11+
Issues labeled ["good first issue"](https://github.com/whatwg/websockets/labels/good%20first%20issue) 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.
1512

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).
13+
If you are thinking of suggesting a new feature, read through the [FAQ](https://whatwg.org/faq) and [Working Mode](https://whatwg.org/working-mode) documents to get yourself familiarized with the process.
14+
15+
We'd be happy to help you with all of this [on Chat](https://whatwg.org/chat).
1816

1917
## Pull requests
2018

21-
In short, change `index.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.
19+
In short, change `index.bs` and submit your patch, with a [good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md).
2420

25-
Please add your name to the Acknowledgments section in your first pull request, even for trivial
26-
fixes. The names are sorted lexicographically.
21+
Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically.
2722

28-
## Building "locally"
23+
To ensure your patch meets all the necessary requirements, please also see the [Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md). Editors of the WebSockets Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
2924

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).
25+
## Tests
3326

34-
## Merge policy
27+
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 the `websockets/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).
3528

36-
If you can commit to this repository, see the
37-
[WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
29+
A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/websockets](https://wpt.fyi/results/websockets).
3830

39-
## Tests
31+
## Building "locally"
4032

41-
Tests can be found in the `websockets/` directory of
42-
[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).
33+
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](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md#building).

0 commit comments

Comments
 (0)