Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meta: update repository files #619

Merged
merged 2 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/0-new-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: New issue
description: File a new issue against the Infra Standard.
body:
- type: markdown
attributes:
value: |
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.

If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
- type: textarea
attributes:
label: "What is the issue with the Infra Standard?"
validations:
required: true
- type: markdown
attributes:
value: "Thank you for taking the time to improve the Infra Standard!"
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/1-new-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: New feature
description: Request a new feature in the Infra Standard.
labels: ["addition/proposal", "needs implementer interest"]
body:
- type: markdown
attributes:
value: |
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.

If at any point you have questions, please reach out to us on [Chat](https://whatwg.org/chat).
- type: textarea
attributes:
label: "What problem are you trying to solve?"
validations:
required: true
- type: textarea
attributes:
label: "What solutions exist today?"
- type: textarea
attributes:
label: "How would you solve it?"
- type: textarea
attributes:
label: "Anything else?"
- type: markdown
attributes:
value: "Thank you for taking the time to improve the Infra Standard!"
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Chat
url: https://whatwg.org/chat
about: Please do reach out with questions and feedback!
- name: Stack Overflow
url: https://stackoverflow.com/
about: If you're having trouble building a web page, this is not the right repository. Consider asking your question on Stack Overflow instead.
7 changes: 3 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,14 @@ on:
jobs:
build:
name: Build
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 2
# Note: `python` will also be this version, which various scripts depend on.
- uses: actions/setup-python@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
python-version: "3.11"
# Note: `make deploy` will do a deploy dry run on PRs.
- run: make deploy
env:
Expand Down
90 changes: 57 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,54 +2,55 @@ This repository hosts the [Infra Standard](https://infra.spec.whatwg.org/).

## Code of conduct

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

## Contribution opportunities

Folks notice minor and larger issues with the Infra Standard all the time and we'd love
your help fixing those. Pull requests for typographical and grammar errors are also most welcome.
Folks notice minor and larger issues with the Infra Standard all the time and we'd love your help fixing those. Pull requests for typographical and grammar errors are also most welcome.

We'd be happy to mentor you through this process. If you're interested and need help getting
started, review the [WHATWG contributing guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md),
and leave a comment on the issue or ask around [on IRC](https://whatwg.org/irc).
Issues labeled ["good first issue"](https://github.com/whatwg/infra/labels/good%20first%20issue) are a good place to get a taste for editing the Infra 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](https://whatwg.org/faq) and [Working Mode](https://whatwg.org/working-mode) documents to get yourself familiarized with the process.

We'd be happy to help you with all of this [on Chat](https://whatwg.org/chat).

## Pull requests

In short, change `infra.bs` and submit your patch after reading through
[WHATWG committing best practices](https://github.com/whatwg/meta/blob/main/COMMITTING.md).
Lastly, please review the [WHATWG FAQ](https://wiki.whatwg.org/wiki/FAQ).
In short, change `infra.bs` and submit your patch, with a [good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md).

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](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md). Editors of the Infra Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).

## Tests

Please add your name to the Acknowledgments section in your first pull request, even for trivial
fixes. The names are sorted lexicographically.
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 Infra Standard can be found in the `infra/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).

A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/infra](https://wpt.fyi/results/infra).

## Building "locally"

For quick local iteration, run `make`. To verify your changes locally, run `make deploy`. See more
in the
[WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md#building).
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).

## Formatting

Use a column width of 100 characters.

Do not use newlines inside "inline" elements, even if that means exceeding the column width
requirement.
Do not use newlines inside "inline" elements, even if that means exceeding the column width requirement.
```html
<li><p>Execute
<a href=https://w3c.github.io/webappsec-csp/#set-response-csp-list>set <var>response</var>'s CSP list</a>
on <var>response</var>. <span data-anolis-ref>CSP</span>
<p>The
<dfn method for=DOMTokenList lt=remove(tokens)|remove()><code>remove(<var>tokens</var>&hellip;)</code></dfn>
method, when invoked, must run these steps:
```
is okay and
```html
<li><p>Execute
<a href=https://w3c.github.io/webappsec-csp/#set-response-csp-list>set <var>response</var>'s CSP
list</a> on <var>response</var>. <span data-anolis-ref>CSP</span>
<p>The <dfn method for=DOMTokenList
lt=remove(tokens)|remove()><code>remove(<var>tokens</var>&hellip;)</code></dfn> method, when
invoked, must run these steps:
```
is not.

Using newlines between "inline" element tag names and their content is also forbidden. (This
actually alters the content, by adding spaces.) That is
Using newlines between "inline" element tag names and their content is also forbidden. (This actually alters the content, by adding spaces.) That is
```html
<a>token</a>
```
Expand All @@ -66,22 +67,45 @@ If a "block" element contains a single "block" element, do not put it on a newli

Do not indent for anything except a new "block" element. For instance
```html
<li><p>Set <var>response</var>'s <span title=concept-response-url-list>url list</span> to a copy of
<var>request</var>'s <span title=concept-request-url-list>url list</span>.
<li><p>For each <var>token</var> in <var>tokens</var>, in given order, that is not in
<a>tokens</a>, append <var>token</var> to <a>tokens</a>.
```
is not indented, but
```html
<ol>
<li>
<p>Run these substeps <span data-anolis-spec=html>in parallel</span>:
<p>For each <var>token</var> in <var>tokens</var>, run these substeps:

<ol>
<li><p>If <var>token</var> is the empty string, <a>throw</a> a {{SyntaxError}} exception.
```
is.

End tags must be omitted when possible and attribute values must not be quoted (if necessary, use
double quotes).
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).

Place one newline between paragraphs (including list elements). Place three newlines before `<h2>`, and two newlines before other headings. This does not apply when a nested heading follows the parent heading.
```html
<ul>
<li><p>Do not place a newline above.

<li><p>Place a newline above.
</ul>

## Merge policy
<p>Place a newline above.

If you can commit to this repository, see the
[WHATWG maintainer guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).

<h3>Place two newlines above.</h3>

<h4>Placing one newline is OK here.</h4>


<h4>Place two newlines above.</h4>
```
Use camel-case for variable names and "spaced" names for definitions, algorithms, etc.
```html
<p>A <a for=/>request</a> has an associated
<dfn export for=request id=concept-request-redirect-mode>redirect mode</dfn>,...
```
```html
<p>Let <var>redirectMode</var> be <var>request</var>'s <a for=request>redirect mode</a>.
```