diff --git a/.gitignore b/.gitignore index 7334d6c..7b374e6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,7 @@ +/UnicodeData.txt /encoding.spec.whatwg.org/ -deploy_key -deploy_key.pub -encoding.html -UnicodeData.txt +/deploy_key +/deploy_key.pub +/deploy.sh +/encoding.html +/review.sh diff --git a/.travis.yml b/.travis.yml index c62d841..996c81e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,9 +3,6 @@ language: generic env: global: - ENCRYPTION_LABEL="eaa0f98d3fae" - - CHECKER_FILTER="Text run is not in Unicode Normalization Form C\.|.*appears to be written in.*|.*Charmod C073.*" - - EXTRA_FILES="*.txt *.json *.css" - - POST_BUILD_STEP='python visualize.py "$DIR/"' script: - make deploy diff --git a/Makefile b/Makefile index 863a151..d79d8d3 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,18 @@ -local: encoding.bs - bikeshed spec encoding.bs encoding.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" +SHELL=/bin/bash -o pipefail remote: encoding.bs curl https://api.csswg.org/bikeshed/ -f -F file=@encoding.bs > encoding.html -F md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" +local: encoding.bs + bikeshed spec encoding.bs encoding.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY" + deploy: encoding.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 + CHECKER_FILTER="Text run is not in Unicode Normalization Form C\.|.*appears to be written in.*|.*Charmod C073.*" \ + EXTRA_FILES="*.txt *.json *.css" \ + POST_BUILD_STEP='python visualize.py "$$DIR/"' \ + bash ./deploy.sh + +review: encoding.bs + curl --remote-name --fail https://resources.whatwg.org/build/review.sh + bash ./review.sh diff --git a/README.md b/README.md index 1d52b06..c7e4732 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ This repository hosts the [Encoding Standard](https://encoding.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'd love your help fixing the minor and larger issues with the Encoding 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 `encoding.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 `encoding/` directory of -[web-platform-tests](https://github.com/w3c/web-platform-tests). +[web-platform-tests/wpt](https://github.com/web-platform-tests/wpt).