Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editorial: Link to whatwg/meta COMMITING.md #867

Merged
merged 7 commits into from
Jan 10, 2018
Merged

Editorial: Link to whatwg/meta COMMITING.md #867

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9e453db
Editorial: Link to whatwg/meta COMMITING.md
snuggs Jan 6, 2018
e576213
Editorial: Change casing of CONTRIBUTING.md
snuggs Jan 7, 2018
cad4067
Editorial: Add reference to whatwg@meta/CONTRIBUTING.md
snuggs Jan 7, 2018
7876095
Editorial: Add Pull Requests section to CONTRIBUTING.md
snuggs Jan 7, 2018
41d975a
Meta: Update Good first commit url
snuggs Jan 10, 2018
726121c
Meta: Consistency
snuggs Jan 10, 2018
5505cc7
Meta: Remove copy & pasta
snuggs Jan 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions Contributing.md → CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
# Contribution guidelines for the Streams Standard
# Streams Standard contributor guidelines
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@domenic "Streams standard"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, in this case "Streams Standard" is a proper noun.


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/html/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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be streams, not html


## Pull Requests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lowercase "r" for consistency


In short, change `source` and submit your patch. Try to follow the [spec editorial conventions](#spec-editorial-conventions) below.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The source file does not exist here.


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

Expand Down Expand Up @@ -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.
Expand Down