bocoup/whatwg-infra

This repository hosts the Infra Standard.

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.

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.

We'd be happy to mentor you through this process. If you're interested and need help getting started, review the WHATWG contributing guidelines, and leave a comment on the issue or ask around on IRC.

Pull requests

In short, change infra.bs and submit your patch after reading through WHATWG committing best practices. Lastly, please review the WHATWG FAQ.

Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically.

Building "locally"

For quick local iteration, run make. To verify your changes locally, run make deploy. See more in the WHATWG Contributor Guidelines.

Formatting

Use a column width of 100 characters.

Do not use newlines inside "inline" elements, even if that means exceeding the column width requirement.

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

is okay and

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

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

<a>token</a>

is fine and

<a>token
</a>

is not.

An <li> element always has a <p> element inside it, unless it's a child of <ul class=brief>.

If a "block" element contains a single "block" element, do not put it on a newline.

Do not indent for anything except a new "block" element. For instance

 <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>.

is not indented, but

 <li>
  <p>Run these substeps <span data-anolis-spec=html>in parallel</span>:

  <ol>

is.

End tags must be omitted when possible and attribute values must not be quoted (if necessary, use double quotes).

Merge policy

If you can commit to this repository, see the WHATWG maintainer guidelines.

bocoup / whatwg-infra