Skip to content

Commit 1f20347

Browse files
annevkannevk
committed
Meta: update repository files
See https://github.com/whatwg/spec-factory for details. (Note that READMEEND.md is a locally maintained addition that is merged into README.md by spec-factory.)
1 parent 3e8cd02 commit 1f20347

File tree

7 files changed

+140
-32
lines changed

7 files changed

+140
-32
lines changed

‎.github/ISSUE_TEMPLATE/0-new-issue.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: New issue
2+
description: File a new issue against the URL 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 URL Standard?"
13+
validations:
14+
required: true
15+
- type: markdown
16+
attributes:
17+
value: "Thank you for taking the time to improve the URL Standard!"

‎.github/ISSUE_TEMPLATE/1-new-feature.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: New feature
2+
description: Request a new feature in the URL 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 URL Standard!"

‎.github/ISSUE_TEMPLATE/config.yml

+8
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

+3-4
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

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
<!--
22
Thank you for contributing to the URL 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
* Node.js: …
1618
- [ ] [MDN issue](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) is filed: …
19+
- [ ] 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. -->
1720

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

‎README.md

+68-27
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,88 @@ This repository hosts the [URL Standard](https://url.spec.whatwg.org/).
22

33
## Code of conduct
44

5-
We are committed to providing a friendly, safe, and welcoming environment for all. Please read and
6-
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).
76

87
## Contribution opportunities
98

10-
Folks notice minor and larger issues with the URL Standard all the time and we'd love your help
11-
fixing those. Pull requests for typographical and grammar errors are also most welcome.
9+
Folks notice minor and larger issues with the URL Standard all the time and we'd love your help fixing those. Pull requests for typographical and grammar errors are also most welcome.
1210

13-
We'd be happy to mentor you through this process. If you're interested and need help getting
14-
started, leave a comment on the issue or ask around [on IRC](https://whatwg.org/irc).
11+
Issues labeled ["good first issue"](https://github.com/whatwg/url/labels/good%20first%20issue) are a good place to get a taste for editing the URL 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-
## Pull requests
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.
1714

18-
In short, change `url.bs` and submit your patch, with a
19-
[good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md). Consider
20-
reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here.
15+
We'd be happy to help you with all of this [on Chat](https://whatwg.org/chat).
2116

22-
If your patch makes normative (behavioral) changes, then
23-
[tests](https://github.com/web-platform-tests/wpt) and the
24-
[jsdom/whatwg-url](https://github.com/jsdom/whatwg-url) implementation will need to be updated as
25-
well (see "Tests and implementations" below). Not all of this is necessarily on you.
17+
## Pull requests
2618

27-
Please add your name to the Acknowledgments section in your first pull request, even for trivial
28-
fixes. The names are sorted lexicographically.
19+
In short, change `url.bs` and submit your patch, with a [good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md).
2920

30-
## Building "locally"
21+
Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically.
3122

32-
For quick local iteration, run `make`. To verify your changes locally, run `make deploy`. See more
33-
in the
34-
[WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md#building).
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 URL Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
3524

36-
## Merge policy
25+
## Tests
3726

38-
If you can commit to this repository, see the
39-
[WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
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 URL Standard can be found in the `url/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).
4028

41-
## Tests and implementations
29+
A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/url](https://wpt.fyi/results/url).
30+
31+
## Building "locally"
4232

43-
Tests can be found in the `url/` directory of
44-
[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt). A dashboard showing the tests
45-
running against major browsers can be seen at [wpt.fyi](https://wpt.fyi/results/url).
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).
34+
35+
## Formatting
36+
37+
Use a column width of 100 characters.
38+
39+
Do not use newlines inside "inline" elements, even if that means exceeding the column width requirement.
40+
```html
41+
<p>The
42+
<dfn method for=DOMTokenList lt=remove(tokens)|remove()><code>remove(<var>tokens</var>&hellip;)</code></dfn>
43+
method, when invoked, must run these steps:
44+
```
45+
is okay and
46+
```html
47+
<p>The <dfn method for=DOMTokenList
48+
lt=remove(tokens)|remove()><code>remove(<var>tokens</var>&hellip;)</code></dfn> method, when
49+
invoked, must run these steps:
50+
```
51+
is not.
52+
53+
Using newlines between "inline" element tag names and their content is also forbidden. (This actually alters the content, by adding spaces.) That is
54+
```html
55+
<a>token</a>
56+
```
57+
is fine and
58+
```html
59+
<a>token
60+
</a>
61+
```
62+
is not.
63+
64+
An `<li>` element always has a `<p>` element inside it, unless it's a child of `<ul class=brief>`.
65+
66+
If a "block" element contains a single "block" element, do not put it on a newline.
67+
68+
Do not indent for anything except a new "block" element. For instance
69+
```html
70+
<li><p>For each <var>token</var> in <var>tokens</var>, in given order, that is not in
71+
<a>tokens</a>, append <var>token</var> to <a>tokens</a>.
72+
```
73+
is not indented, but
74+
```html
75+
<ol>
76+
<li>
77+
<p>For each <var>token</var> in <var>tokens</var>, run these substeps:
78+
79+
<ol>
80+
<li><p>If <var>token</var> is the empty string, <a>throw</a> a {{SyntaxError}} exception.
81+
```
82+
is.
83+
84+
End tags may be included (if done consistently) and attributes may be quoted (using double quotes), though the prevalent theme is to omit end tags and not quote attributes (unless they contain a space).
85+
86+
## Implementations
4687

4788
A complete JavaScript implementation of the standard can be found at
4889
[jsdom/whatwg-url](https://github.com/jsdom/whatwg-url). This implementation is kept synchronized

‎READMEEND.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Implementations
2+
3+
A complete JavaScript implementation of the standard can be found at
4+
[jsdom/whatwg-url](https://github.com/jsdom/whatwg-url). This implementation is kept synchronized
5+
with the standard and tests.
6+
7+
A complete C++ implementation of the standard can be found at
8+
[ada-url/ada](https://github.com/ada-url/ada). This implementation is kept synchronized
9+
with the standard and tests, and is currently used in [Node.js](https://github.com/nodejs/node).
10+
11+
The [Live URL Viewer](https://jsdom.github.io/whatwg-url/) lets you manually test-parse any URL,
12+
comparing your browser's URL parser to that of
13+
[jsdom/whatwg-url](https://github.com/jsdom/whatwg-url).

0 commit comments

Comments
 (0)