diff --git a/.gitignore b/.gitignore index 21cccd1..fbc589a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ /fullscreen.spec.whatwg.org/ -deploy_key -deploy_key.pub -deploy.sh -fullscreen.html +/deploy_key +/deploy_key.pub +/deploy.sh +/fullscreen.html +/review.sh diff --git a/Makefile b/Makefile index 439368b..3a0459d 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,13 @@ -local: fullscreen.bs - bikeshed spec fullscreen.bs fullscreen.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" - remote: fullscreen.bs curl https://api.csswg.org/bikeshed/ -f -F file=@fullscreen.bs > fullscreen.html -F md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" +local: fullscreen.bs + bikeshed spec fullscreen.bs fullscreen.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" + deploy: fullscreen.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: fullscreen.bs + curl --remote-name --fail https://resources.whatwg.org/build/review.sh + bash ./review.sh diff --git a/README.md b/README.md index 2a54998..e5fe3e5 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ This repository hosts the [Fullscreen API Standard](https://fullscreen.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 Fullscreen API 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 `fullscreen.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 [maintainer guidelines](https://github.com/whatwg/meta/blob/master/MAINTAINERS.md). -### Tests +## Tests Tests can be found in the `fullscreen/` directory of -[`web-platform-tests`](https://github.com/w3c/web-platform-tests). +[`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).