diff --git a/.gitignore b/.gitignore index 5251c10..634f4e6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ /storage.spec.whatwg.org/ -deploy_key -deploy_key.pub -deploy.sh -storage.html +/deploy_key +/deploy_key.pub +/deploy.sh +/review.sh +/storage.html diff --git a/Makefile b/Makefile index 55ff807..920b625 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,13 @@ -local: storage.bs - bikeshed spec storage.bs storage.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" - remote: storage.bs curl https://api.csswg.org/bikeshed/ -f -F file=@storage.bs > storage.html -F md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" +local: storage.bs + bikeshed spec storage.bs storage.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" + deploy: storage.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: storage.bs + curl --remote-name --fail https://resources.whatwg.org/build/review.sh + bash ./review.sh diff --git a/README.md b/README.md index c819049..e4813bf 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ This repository hosts the [Storage Standard](https://storage.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 We've love your help fixing minor and larger issues with the Storage Standard. 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 `storage.bs` and submit your patch, with a [good commit message](https://github.com/whatwg/meta/blob/master/COMMITTING.md). Consider @@ -22,19 +22,18 @@ 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). -### Merge policy +## Merge policy If you can commit to this repository, see the [WHATWG Maintainer Guidelines](https://github.com/whatwg/meta/blob/master/MAINTAINERS.md). -### Tests +## Tests Tests can be found in the `storage/` directory of -[`web-platform-tests`](https://github.com/w3c/web-platform-tests). +[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).