Permalink
Browse files

Meta: reference whatwg/meta resources

Helps with whatwg/meta#65.
  • Loading branch information...
snuggs authored and domenic committed Jan 10, 2018
1 parent 1686cb8 commit 8f3e114eca07505bd94877e30c5e7dc9c8402ab4
Showing with 15 additions and 9 deletions.
  1. +15 −9 Contributing.md → CONTRIBUTING.md
@@ -1,4 +1,18 @@
# Contribution guidelines for the Streams Standard
# Streams Standard contributor guidelines
These are the guidelines for contributing to the Streams Standard. First see the [WHATWG contributor guidelines](https://github.com/whatwg/meta/blob/master/CONTRIBUTING.md).
We label [good first issues](https://github.com/whatwg/streams/labels/good%20first%20issue) that you could help us fix, to get a taste for how to submit pull requests, how the build process works, and so on.
## Pull requests
Try to follow the [spec editorial conventions](#spec-editorial-conventions) below.
Follow the [guidelines for writing good commit messages](https://github.com/whatwg/meta/blob/master/COMMITTING.md).
Merge commits are not allowed; history must stay linear.
If you are updating the spec, also update the corresponding parts of the reference implementation where applicable, in the same commit.
## Spec editorial conventions
@@ -35,14 +49,6 @@ Use single quotes.
Pass ESLint.
## Commit guidelines
Follow the [guidelines for writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages).
Merge commits are not allowed; history must stay linear.
If you are updating the spec, also update the corresponding parts of the reference implementation where applicable, in the same commit.
## Building the spec
Building the spec is a two-step process. First, the majority of the conversion work is done via [Bikeshed](https://github.com/tabatkins/bikeshed). Second, we run a custom portion of the [Ecmarkup](https://github.com/bterlson/ecmarkup) pipeline to convert the algorithms from [Ecmarkdown](https://github.com/domenic/ecmarkdown) syntax into HTML, and to automatically add cross-references. This second step requires a recent version of [Node.js](https://nodejs.org/en/) to be installed.

0 comments on commit 8f3e114

Please sign in to comment.