|
1 |
| -# File System Standard |
2 |
| - |
3 |
| -This repository hosts the |
4 |
| -[File System Standard](https://fs.spec.whatwg.org/). |
| 1 | +This repository hosts the [File System Standard](https://fs.spec.whatwg.org/). |
5 | 2 |
|
6 | 3 | ## Code of conduct
|
7 | 4 |
|
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). |
10 | 6 |
|
11 | 7 | ## Contribution opportunities
|
12 | 8 |
|
13 |
| -Folks notice minor and larger issues with the File System 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 File System 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/fs/labels/good%20first%20issue) are a good place to get a taste for editing the File System Standard. Note that we don't assign issues and there's no reason to ask for availability either, just provide a pull request. |
15 | 12 |
|
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). |
18 | 16 |
|
19 | 17 | ## Pull requests
|
20 | 18 |
|
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). |
24 | 20 |
|
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. |
27 | 22 |
|
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 File System Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md). |
29 | 24 |
|
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 |
33 | 26 |
|
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 File System Standard can be found in the `fs/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt). |
35 | 28 |
|
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/fs](https://wpt.fyi/results/fs). |
38 | 30 |
|
39 |
| -## Tests |
| 31 | +## Building "locally" |
40 | 32 |
|
41 |
| -Tests can be found in the `fs/` 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