From fa6f2b0c3a1a327e198c8b04ea8db71b3489089d Mon Sep 17 00:00:00 2001 From: Anne van Kesteren Date: Tue, 29 May 2018 16:52:24 +0200 Subject: [PATCH] Meta: Review Draft infrastructure See https://github.com/whatwg/whatwg.org/issues/197 and https://github.com/whatwg/meta/issues/92 for details. This also updates the web-platform-tests and IRC URLs. --- .gitignore | 9 +++++---- Makefile | 13 +++++++++---- README.md | 27 +++++++++++++-------------- 3 files changed, 27 insertions(+), 22 deletions(-) diff --git a/.gitignore b/.gitignore index 03379c03a..b749db69a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ /fetch.spec.whatwg.org/ -deploy_key -deploy_key.pub -deploy.sh -fetch.html +/deploy_key +/deploy_key.pub +/deploy.sh +/fetch.html +/review.sh diff --git a/Makefile b/Makefile index 96198a9d8..664adb701 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,13 @@ -local: fetch.bs - bikeshed spec fetch.bs fetch.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" - remote: fetch.bs curl https://api.csswg.org/bikeshed/ -f -F file=@fetch.bs > fetch.html -F md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" +local: fetch.bs + bikeshed spec fetch.bs fetch.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" + deploy: fetch.bs - curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh && bash ./deploy.sh + curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh + bash ./deploy.sh + +review: fetch.bs + curl --remote-name --fail https://resources.whatwg.org/build/review.sh + bash ./review.sh diff --git a/README.md b/README.md index f7280559b..072dc57bd 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ This repository hosts the [Fetch Standard](https://fetch.spec.whatwg.org/). -### Code of conduct +## Code of conduct -We are committed to providing a friendly, safe and welcoming environment for all. Please read and +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). -### Contribution opportunities +## Contribution opportunities Folks notice minor and larger issues with the Fetch 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://wiki.whatwg.org/wiki/IRC). +started, leave a comment on the issue or ask around [on IRC](https://whatwg.org/irc). -### Pull requests +## Pull requests In short, change `fetch.bs` and submit your patch, with a [good commit message](https://github.com/whatwg/meta/blob/master/COMMITTING.md). Consider @@ -22,14 +22,13 @@ reading through the [WHATWG FAQ](https://whatwg.org/faq) if you are new here. Please add your name to the Acknowledgments section in your first pull request, even for trivial fixes. The names are sorted lexicographically. -If you want to preview the spec locally, you can either use a locally installed copy of -[Bikeshed](https://github.com/tabatkins/bikeshed) by running `make` or use the HTTP API version by -running `make remote`. +## Building "locally" -If you want to do a complete "local deploy" including commit and/or branch snapshots, run -`make deploy`. +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/master/CONTRIBUTING.md#building). -#### Formatting +## Formatting Use a column width of 100 characters. @@ -81,12 +80,12 @@ is. End tags must be omitted when possible and attribute values must not be quoted (if necessary, use double quotes). -### Merge policy +## Merge policy If you can commit to this repository, see the [maintainer guidelines](https://github.com/whatwg/meta/blob/master/MAINTAINERS.md). -### Tests +## Tests Tests can be found in the `fetch/` directory of -[web-platform-tests](https://github.com/w3c/web-platform-tests). +[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).