From 9e453db92b5807b0b53888635a5bd87c82157bbe Mon Sep 17 00:00:00 2001 From: Ra'Shaun Stovall Date: Sat, 6 Jan 2018 09:26:20 -0500 Subject: [PATCH 1/7] Editorial: Link to whatwg/meta COMMITING.md Addresses: - https://github.com/whatwg/meta/issues/65 --- Contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Contributing.md b/Contributing.md index 906886e78..6d4a27b68 100644 --- a/Contributing.md +++ b/Contributing.md @@ -37,7 +37,7 @@ Pass ESLint. ## Commit guidelines -Follow the [guidelines for writing good commit messages](https://github.com/erlang/otp/wiki/Writing-good-commit-messages). +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. From e5762137bbd5f794c77167a9436260d457689235 Mon Sep 17 00:00:00 2001 From: Ra'Shaun Stovall Date: Sun, 7 Jan 2018 09:03:38 -0500 Subject: [PATCH 2/7] Editorial: Change casing of CONTRIBUTING.md Addresses: - https://github.com/whatwg/streams/pull/867#issuecomment-355814595 --- Contributing.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Contributing.md => CONTRIBUTING.md (100%) diff --git a/Contributing.md b/CONTRIBUTING.md similarity index 100% rename from Contributing.md rename to CONTRIBUTING.md From cad406715fe669f001a21ef3d5d42d4ddc4ba6da Mon Sep 17 00:00:00 2001 From: Ra'Shaun Stovall Date: Sun, 7 Jan 2018 09:09:12 -0500 Subject: [PATCH 3/7] Editorial: Add reference to whatwg@meta/CONTRIBUTING.md Addresses: - https://github.com/snuggs/streams/commit/e5762137bbd5f794c77167a9436260d457689235 --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d4a27b68..6d3a5da0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,6 @@ -# 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). ## Spec editorial conventions From 7876095459c7e0853fd26286de8121a9bc86d757 Mon Sep 17 00:00:00 2001 From: Ra'Shaun Stovall Date: Sun, 7 Jan 2018 09:17:23 -0500 Subject: [PATCH 4/7] Editorial: Add Pull Requests section to CONTRIBUTING.md Addresses: - https://github.com/snuggs/streams/commit/e5762137bbd5f794c77167a9436260d457689235 References: - https://github.com/whatwg/html/blob/master/CONTRIBUTING.md --- CONTRIBUTING.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d3a5da0c..41b29ba8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,18 @@ 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. + +## Pull Requests + +In short, change `source` and submit your patch. 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 Wrap lines to 120 columns. (This is not yet consistently followed.) @@ -37,14 +49,6 @@ Use single quotes. Pass ESLint. -## Commit guidelines - -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. - ## 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. From 41d975a47ca86979b1fbd8bee8f6244786940e84 Mon Sep 17 00:00:00 2001 From: Ra'Shaun Stovall Date: Wed, 10 Jan 2018 08:37:58 -0500 Subject: [PATCH 5/7] Meta: Update Good first commit url Addresses: - https://github.com/whatwg/streams/pull/867/files#r160275278 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41b29ba8b..ad48ea77b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ 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. +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 From 726121c8a1a3934d95131f1d1a4e2fb83e50ed8e Mon Sep 17 00:00:00 2001 From: Ra'Shaun Stovall Date: Wed, 10 Jan 2018 09:13:33 -0500 Subject: [PATCH 6/7] Meta: Consistency Addresses: - https://github.com/whatwg/streams/pull/867/files#r160275278 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad48ea77b..5c7a9c879 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ These are the guidelines for contributing to the Streams Standard. First see the 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 +## Pull requests In short, change `source` and submit your patch. Try to follow the [spec editorial conventions](#spec-editorial-conventions) below. From 5505cc70cc86d5654ab6c8ca7ef1904ea03c5668 Mon Sep 17 00:00:00 2001 From: Ra'Shaun Stovall Date: Wed, 10 Jan 2018 09:14:54 -0500 Subject: [PATCH 7/7] Meta: Remove copy & pasta Addresses: - https://github.com/whatwg/streams/pull/867/files#r160275278 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c7a9c879..13431f799 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ We label [good first issues](https://github.com/whatwg/streams/labels/good%20fir ## Pull requests -In short, change `source` and submit your patch. Try to follow the [spec editorial conventions](#spec-editorial-conventions) below. +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).