From 951da4c30a6e417574b97ea3634cbe72c83521eb Mon Sep 17 00:00:00 2001 From: Anne van Kesteren Date: Sun, 15 Mar 2026 10:00:29 +0100 Subject: [PATCH 1/2] Meta: update repository files See https://github.com/whatwg/spec-factory for details. --- .github/CONTRIBUTING.md | 1 + .../pull_request_template.md | 0 CONTRIBUTING.md | 35 ------------------- Makefile | 6 ++-- 4 files changed, 5 insertions(+), 37 deletions(-) create mode 100644 .github/CONTRIBUTING.md rename PULL_REQUEST_TEMPLATE.md => .github/pull_request_template.md (100%) delete mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..d1ad113d --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1 @@ +Please see the [WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md). diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/pull_request_template.md similarity index 100% rename from PULL_REQUEST_TEMPLATE.md rename to .github/pull_request_template.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 68025ef3..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,35 +0,0 @@ -# Streams Standard contributor guidelines - -These are the guidelines for contributing to the Streams Standard. First see the [WHATWG contributor guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md). - -We label [good first issues](https://github.com/whatwg/streams/labels/good%20first%20issue) that you could help us fix, to get a taste for how to submit pull requests, how the build process works, and so on. - -## Spec editorial conventions - -In general, follow existing practice. - -Wrap lines to 100 columns. - -Use single-space indents. - -Do not introduce explicit `

` tags. (Bikeshed does this automatically.) - -Mark up definitions [appropriately](https://speced.github.io/bikeshed/#definitions). This is mostly applicable when defining new classes or methods; follow the existing examples in the spec. - -Use cross-reference [autolinking](https://speced.github.io/bikeshed/#autolinking) liberally. This generally amounts to writing references to "definitions" as `[=term=]`, and writing references to classes or methods as `{{ClassName}}` or `{{ClassName/methodName()}}`. - -When writing examples or notes, JavaScript variables and values are enclosed in `` tags, not in `` tags. - -Use abstract operations to factor out shared logic used by multiple public APIs, or by multiple other abstract operations. - -## Reference implementation style - -Wrap lines to 120 columns. - -Use two-space indents. - -Alphabetize imports. - -Use single quotes. - -Pass ESLint. diff --git a/Makefile b/Makefile index 7544749f..19a0d3e3 100644 --- a/Makefile +++ b/Makefile @@ -2,13 +2,15 @@ SHELL=/bin/bash -o pipefail .PHONY: local remote deploy remote: index.bs - @ (HTTP_STATUS=$$(curl https://api.csswg.org/bikeshed/ \ + @ (HTTP_STATUS=$$(curl https://www.w3.org/publications/spec-generator/ \ --output index.html \ --write-out "%{http_code}" \ --header "Accept: text/plain, text/html" \ -F die-on=warning \ -F md-Text-Macro="COMMIT-SHA LOCAL COPY" \ - -F file=@index.bs) && \ + -F file=@index.bs \ + -F type=bikeshed-spec \ + -F output=html) && \ [[ "$$HTTP_STATUS" -eq "200" ]]) || ( \ echo ""; cat index.html; echo ""; \ rm -f index.html; \ From ac47f8768716bc405c057b9e65729033cc817a05 Mon Sep 17 00:00:00 2001 From: Anne van Kesteren Date: Mon, 16 Mar 2026 08:11:51 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- .github/CONTRIBUTING.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d1ad113d..0b3aed01 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1 +1,35 @@ -Please see the [WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md). +# Streams Standard contributor guidelines + +These are the guidelines for contributing to the Streams Standard. First see the [WHATWG Contributor Guidelines](https://github.com/whatwg/meta/blob/main/CONTRIBUTING.md). + +We label [good first issues](https://github.com/whatwg/streams/labels/good%20first%20issue) that you could help us fix, to get a taste for how to submit pull requests, how the build process works, and so on. + +## Spec editorial conventions + +In general, follow existing practice. + +Wrap lines to 100 columns. + +Use single-space indents. + +Do not introduce explicit `

` tags. (Bikeshed does this automatically.) + +Mark up definitions [appropriately](https://speced.github.io/bikeshed/#definitions). This is mostly applicable when defining new classes or methods; follow the existing examples in the spec. + +Use cross-reference [autolinking](https://speced.github.io/bikeshed/#autolinking) liberally. This generally amounts to writing references to "definitions" as `[=term=]`, and writing references to classes or methods as `{{ClassName}}` or `{{ClassName/methodName()}}`. + +When writing examples or notes, JavaScript variables and values are enclosed in `` tags, not in `` tags. + +Use abstract operations to factor out shared logic used by multiple public APIs, or by multiple other abstract operations. + +## Reference implementation style + +Wrap lines to 120 columns. + +Use two-space indents. + +Alphabetize imports. + +Use single quotes. + +Pass ESLint.