Meta: update repository files

See https://github.com/whatwg/spec-factory for details.
whatwg · Sep 27, 2023 · c82851b · c82851b
1 parent 337fdc8
commit c82851b
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 38 deletions.
diff --git a/.github/ISSUE_TEMPLATE/0-new-issue.yml b/.github/ISSUE_TEMPLATE/0-new-issue.yml
@@ -0,0 +1,17 @@
+name: New issue
+description: File a new issue against the DOM 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 DOM Standard?"
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: "Thank you for taking the time to improve the DOM Standard!"
diff --git a/.github/ISSUE_TEMPLATE/1-new-feature.yml b/.github/ISSUE_TEMPLATE/1-new-feature.yml
@@ -0,0 +1,27 @@
+name: New feature
+description: Request a new feature in the DOM 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 DOM Standard!"
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -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.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -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:

diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -1,18 +1,21 @@
 <!--
 Thank you for contributing to the DOM 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: …
    * Deno (only for aborting and events): …
    * Node.js (only for aborting and events): …
 - [ ] [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.)
diff --git a/README.md b/README.md
@@ -2,41 +2,41 @@ This repository hosts the [DOM Standard](https://dom.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 DOM 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 DOM 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/dom/labels/good%20first%20issue) are a
-good place to get a taste for editing the DOM Standard and providing a pull request.
+Issues labeled ["good first issue"](https://github.com/whatwg/dom/labels/good%20first%20issue) are a good place to get a taste for editing the DOM 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 IRC](https://whatwg.org/irc).
+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 `dom.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 `dom.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 DOM Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
+
+## Tests
+
+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 DOM Standard can be found in the `dom/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).
 
-Please add your name to the Acknowledgments section in your first pull request, even for trivial
-fixes. The names are sorted lexicographically.
+A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/dom](https://wpt.fyi/results/dom).
 
 ## 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
 <p>The
 <dfn method for=DOMTokenList lt=remove(tokens)|remove()><code>remove(<var>tokens</var>&hellip;)</code></dfn>
@@ -50,8 +50,7 @@ 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>
 ```
@@ -82,16 +81,4 @@ is not indented, but
 ```
 is.
 
-End tags may be included (if done consistently) and attributes may be quoted (using double quotes),
-though the prevelant theme is to omit end tags and not quote attributes (unless they contain a
-space).
-
-## Merge policy
-
-If you can commit to this repository, see the
-[WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
-
-## Tests
-
-Tests can be found in the `dom/` directory of
-[`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).
+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).