Skip to content

Commit

Permalink
Meta: Review Draft infrastructure
Browse files Browse the repository at this point in the history
See whatwg/whatwg.org#197 and whatwg/meta#92 for details.

This also updates the web-platform-tests and IRC URLs.
  • Loading branch information
annevk authored and domenic committed May 29, 2018
1 parent b10ba96 commit eb0db13
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 22 deletions.
9 changes: 5 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/dom.spec.whatwg.org/
deploy_key
deploy_key.pub
dom.html
deploy.sh
/deploy.sh
/deploy_key
/deploy_key.pub
/dom.html
/review.sh
13 changes: 9 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
local: dom.bs
bikeshed spec dom.bs dom.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY"

remote: dom.bs
curl https://api.csswg.org/bikeshed/ -f -F [email protected] > dom.html -F md-Text-Macro="SNAPSHOT-LINK LOCAL COPY"

local: dom.bs
bikeshed spec dom.bs dom.html --md-Text-Macro="SNAPSHOT-LINK LOCAL COPY"

deploy: dom.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: dom.bs
curl --remote-name --fail https://resources.whatwg.org/build/review.sh
bash ./review.sh
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
This repository hosts the [DOM Standard](https://dom.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 DOM Standard all the time and we'd love your help
fixing those. Pull requests for typographical and grammar errors are also most welcome.
Expand All @@ -14,9 +14,9 @@ Issues labeled ["good first issue"](https://github.com/whatwg/dom/labels/good%20
good place to get a taste for editing the DOM Standard and providing a pull request.

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 `dom.bs` and submit your patch, with a
[good commit message](https://github.com/whatwg/meta/blob/master/COMMITTING.md). Consider
Expand All @@ -25,14 +25,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.

Expand Down Expand Up @@ -87,12 +86,12 @@ End tags may be included (if done consistently) and attributes may be quoted (us
though the prevelant theme is to omit end tags and not quote attributes (unless they contain a
space).

### 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 `dom/` directory of
[`web-platform-tests`](https://github.com/w3c/web-platform-tests).
[`web-platform-tests/wpt`](https://github.com/web-platform-tests/wpt).

0 comments on commit eb0db13

Please sign in to comment.