-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
See https://github.com/whatwg/spec-factory for details.
- Loading branch information
Showing
6 changed files
with
75 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| name: New issue | ||
| description: File a new issue against the File System 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 File System Standard?" | ||
| validations: | ||
| required: true | ||
| - type: markdown | ||
| attributes: | ||
| value: "Thank you for taking the time to improve the File System Standard!" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: New feature | ||
| description: Request a new feature in the File System 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 File System Standard!" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,19 @@ | ||
| <!-- | ||
| Thank you for contributing to the File System Standard! Please describe the change you are making and complete the checklist below if your change is not editorial. | ||
| When editing this comment after the PR is created, check that PR-Preview doesn't overwrite your changes. | ||
| If you think your PR is ready to land, please double-check that the build is passing and the checklist is complete before pinging. | ||
| --> | ||
|
|
||
| - [ ] At least two implementers are interested (and none opposed): | ||
| * … | ||
| * … | ||
| - [ ] [Tests](https://github.com/web-platform-tests/wpt) are written and can be reviewed and commented upon at: | ||
| * … | ||
| * … <!-- If these tests are tentative, link a PR to make them non-tentative. --> | ||
| - [ ] [Implementation bugs](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) are filed: | ||
| * Chromium: … | ||
| * Gecko: … | ||
| * WebKit: … | ||
| - [ ] [MDN issue](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md#handling-pull-requests) is filed: … | ||
| - [ ] 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. --> | ||
|
|
||
| (See [WHATWG Working Mode: Changes](https://whatwg.org/working-mode#changes) for more details.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,33 @@ | ||
| # File System Standard | ||
|
|
||
| This repository hosts the | ||
| [File System Standard](https://fs.spec.whatwg.org/). | ||
| This repository hosts the [File System Standard](https://fs.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 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. | ||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| We'd be happy to mentor you through this process. If you're interested and need help getting | ||
| started, leave a comment on the issue or ask around [on chat](https://whatwg.org/chat). | ||
| 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 `index.bs` and submit your patch, with a | ||
| [good commit message](https://github.com/whatwg/meta/blob/main/COMMITTING.md). Consider | ||
| reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here. | ||
| In short, change `index.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. | ||
| Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically. | ||
|
|
||
| ## Building "locally" | ||
| 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). | ||
|
|
||
| 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). | ||
| ## Tests | ||
|
|
||
| ## Merge policy | ||
| 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). | ||
|
|
||
| If you can commit to this repository, see the | ||
| [WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md). | ||
| A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/fs](https://wpt.fyi/results/fs). | ||
|
|
||
| ## Tests | ||
| ## Building "locally" | ||
|
|
||
| Tests can be found in the `fs/` directory of | ||
| [web-platform-tests/wpt](https://github.com/web-platform-tests/wpt). | ||
| 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). |