|
1 | | -This repository hosts the |
2 | | -[Notifications API Standard](https://notifications.spec.whatwg.org/). |
| 1 | +This repository hosts the [Notifications API Standard](https://notifications.spec.whatwg.org/). |
3 | 2 |
|
4 | 3 | ## Code of conduct |
5 | 4 |
|
6 | | -We are committed to providing a friendly, safe, and welcoming environment for all. Please read and |
7 | | -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). |
8 | 6 |
|
9 | 7 | ## Contribution opportunities |
10 | 8 |
|
11 | | -Folks notice minor and larger issues with the Notifications API Standard all the time and we'd love |
12 | | -your help fixing those. Pull requests for typographical and grammar errors are also most welcome. |
| 9 | +Folks notice minor and larger issues with the Notifications API Standard all the time and we'd love your help fixing those. Pull requests for typographical and grammar errors are also most welcome. |
13 | 10 |
|
14 | | -We'd be happy to mentor you through this process. If you're interested and need help getting |
15 | | -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/notifications/labels/good%20first%20issue) are a good place to get a taste for editing the Notifications API Standard. Note that we don't assign issues and there's no reason to ask for availability either, just provide a pull request. |
| 12 | + |
| 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). |
16 | 16 |
|
17 | 17 | ## Pull requests |
18 | 18 |
|
19 | | -In short, change `notifications.bs` and submit your patch, with a |
20 | | -[good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md). Consider |
21 | | -reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here. |
| 19 | +In short, change `notifications.bs` and submit your patch, with a [good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md). |
| 20 | + |
| 21 | +Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically. |
| 22 | + |
| 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 Notifications API Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md). |
| 24 | + |
| 25 | +## Tests |
22 | 26 |
|
23 | | -Please add your name to the Acknowledgments section in your first pull request, even for trivial |
24 | | -fixes. The names are sorted lexicographically. |
| 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 Notifications API Standard can be found in the `notifications/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt). |
| 28 | + |
| 29 | +A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/notifications](https://wpt.fyi/results/notifications). |
25 | 30 |
|
26 | 31 | ## Building "locally" |
27 | 32 |
|
28 | | -For quick local iteration, run `make`. To verify your changes locally, run `make deploy`. See more |
29 | | -in the |
30 | | -[WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md#building). |
| 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). |
31 | 34 |
|
32 | | -## Merge policy |
| 35 | +## Formatting |
33 | 36 |
|
34 | | -If you can commit to this repository, see the |
35 | | -[WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md). |
| 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>…)</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>…)</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 | +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. |
| 87 | +```html |
| 88 | +<ul> |
| 89 | + <li><p>Do not place a newline above. |
| 90 | + |
| 91 | + <li><p>Place a newline above. |
| 92 | +</ul> |
| 93 | + |
| 94 | +<p>Place a newline above. |
| 95 | + |
| 96 | + |
| 97 | +<h3>Place two newlines above.</h3> |
| 98 | + |
| 99 | +<h4>Placing one newline is OK here.</h4> |
36 | 100 |
|
37 | | -## Tests |
38 | 101 |
|
39 | | -Tests can be found in the `notifications/` directory of |
40 | | -[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt). |
| 102 | +<h4>Place two newlines above.</h4> |
| 103 | +``` |
| 104 | +Use camel-case for variable names and "spaced" names for definitions, algorithms, etc. |
| 105 | +```html |
| 106 | +<p>A <a for=/>request</a> has an associated |
| 107 | +<dfn export for=request id=concept-request-redirect-mode>redirect mode</dfn>,... |
| 108 | +``` |
| 109 | +```html |
| 110 | +<p>Let <var>redirectMode</var> be <var>request</var>'s <a for=request>redirect mode</a>. |
| 111 | +``` |
0 commit comments