majacQ · pull · Aug 16, 2021 · Oct 19, 2021 · Oct 25, 2021 · Oct 26, 2021
diff --git a/.editorconfig b/.editorconfig
@@ -12,6 +12,9 @@ max_line_length = 100
 [Makefile]
 indent_style = tab
 
+[*.md]
+max_line_length = off
+
 [*.bs]
 indent_size = 1
 

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 XMLHttpRequest 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 XMLHttpRequest Standard?"
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: "Thank you for taking the time to improve the XMLHttpRequest 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 XMLHttpRequest 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 XMLHttpRequest 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
@@ -1,23 +1,26 @@
 name: Build
+
 on:
   pull_request:
     branches:
     - main
   push:
     branches:
     - main
+  workflow_dispatch:
+
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 2
-    # Note: `python` will also be this version, which various scripts depend on.
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v5
       with:
-        python-version: 3.8
+        python-version: "3.11"
+    - run: pip install bikeshed && bikeshed update
     # Note: `make deploy` will do a deploy dry run on PRs.
     - run: make deploy
       env:

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,3 @@
 /xhr.spec.whatwg.org/
 /deploy.sh
 /xhr.html
-/review.sh
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 SHELL=/bin/bash -o pipefail
-.PHONY: local remote deploy review
+.PHONY: local remote deploy
 
 remote: xhr.bs
 	@ (HTTP_STATUS=$$(curl https://api.csswg.org/bikeshed/ \
@@ -16,12 +16,8 @@ remote: xhr.bs
 	);
 
 local: xhr.bs
-	bikeshed spec xhr.bs xhr.html --md-Text-Macro="COMMIT-SHA LOCAL COPY"
+	bikeshed spec xhr.bs xhr.html --md-Text-Macro="COMMIT-SHA LOCAL-COPY"
 
 deploy: xhr.bs
 	curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh
 	bash ./deploy.sh
-
-review: xhr.bs
-	curl --remote-name --fail https://resources.whatwg.org/build/review.sh
-	bash ./review.sh
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -1,15 +1,21 @@
 <!--
 Thank you for contributing to the XMLHttpRequest Standard! Please describe the change you are making and complete the checklist below if your change is not editorial.
+
+When you submit this PR, and each time you edit this comment (including checking a checkbox through the UI!), PR Preview will run and update it. As such make any edits in one go and only after PR Preview has run.
+
+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:
-   * Chrome: …
-   * Firefox: …
-   * Safari: …
+   * 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.)
diff --git a/README.md b/README.md
@@ -2,38 +2,110 @@ This repository hosts the [XMLHttpRequest Standard](https://xhr.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
 
-We'd love your help fixing outstanding issues. Pull requests for typographical and grammar errors
-are also most welcome.
+Folks notice minor and larger issues with the XMLHttpRequest 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, leave a comment on the issue or ask around [on IRC](https://whatwg.org/irc).
+Issues labeled ["good first issue"](https://github.com/whatwg/xhr/labels/good%20first%20issue) are a good place to get a taste for editing the XMLHttpRequest Standard. Note that we don't assign issues and there's no reason to ask for availability either, just provide a pull request.
+
+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 `xhr.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 `xhr.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 XMLHttpRequest Standard are expected to follow the [Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
+
+## Tests
 
-Please add your name to the Acknowledgments section in your first pull request, even for trivial
-fixes. The names are sorted lexicographically.
+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 XMLHttpRequest Standard can be found in the `xhr/` directory of [`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).
+
+A dashboard showing the tests running against browser engines can be seen at [wpt.fyi/results/xhr](https://wpt.fyi/results/xhr).
 
 ## 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).
 
-## Merge policy
+## Formatting
 
-If you can commit to this repository, see the
-[WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/main/MAINTAINERS.md).
+Use a column width of 100 characters.
+
+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>
+method, when invoked, must run these steps:
+```
+is okay and
+  ```html
+<p>The <dfn method for=DOMTokenList
+lt=remove(tokens)|remove()><code>remove(<var>tokens</var>&hellip;)</code></dfn> method, when
+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
+```html
+<a>token</a>
+```
+is fine and
+```html
+<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
+```html
+ <li><p>For each <var>token</var> in <var>tokens</var>, in given order, that is not in
+ <a>tokens</a>, append <var>token</var> to <a>tokens</a>.
+```
+is not indented, but
+```html
+<ol>
+ <li>
+  <p>For each <var>token</var> in <var>tokens</var>, run these substeps:
+
+  <ol>
+   <li><p>If <var>token</var> is the empty string, <a>throw</a> a {{SyntaxError}} exception.
+```
+is.
+
+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).
+
+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.
+```html
+<ul>
+ <li><p>Do not place a newline above.
+
+ <li><p>Place a newline above.
+</ul>
+
+<p>Place a newline above.
+
+
+<h3>Place two newlines above.</h3>
+
+<h4>Placing one newline is OK here.</h4>
 
-## Tests
 
-Tests can be found in the `xhr/` directory of
-[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).
+<h4>Place two newlines above.</h4>
+```
+Use camel-case for variable names and "spaced" names for definitions, algorithms, etc.
+```html
+<p>A <a for=/>request</a> has an associated
+<dfn export for=request id=concept-request-redirect-mode>redirect mode</dfn>,...
+```
+```html
+<p>Let <var>redirectMode</var> be <var>request</var>'s <a for=request>redirect mode</a>.
+```