From 1fb9fd7aafad075f3ba715f4ec6baa1ca887f0b8 Mon Sep 17 00:00:00 2001 From: Salame William Date: Thu, 28 Dec 2017 17:31:53 +0100 Subject: [PATCH 1/3] doc: added articles about PR communication in CONTRIBUTING.md Added some references to PR communication articles in Helpful Ressources inside CONTRIBUTING.md Fixes: https://github.com/nodejs/node/issues/16359 --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d27959c6dc5dbd..ba8315f58e9bc9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -828,6 +828,8 @@ The following additional resources may be of assistance: * [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) * [core-validate-commit](https://github.com/evanlucas/core-validate-commit) - A utility that ensures commits follow the commit formatting guidelines. +* How to respectfully and usefully review code part [one](https://mtlynch.io/human-code-reviews-1/) and [two](https://mtlynch.io/human-code-reviews-2/) +* [How to write a positive code review](https://css-tricks.com/code-review-etiquette/) ## Developer's Certificate of Origin 1.1 From 670ddfd2806ee8db1ce64e42564d19f54d18b5d3 Mon Sep 17 00:00:00 2001 From: Salame William Date: Fri, 29 Dec 2017 00:10:26 +0100 Subject: [PATCH 2/3] doc: fixed a forgotten comma Added a forgotten comma inside CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ba8315f58e9bc9..cd63ce63ad84e7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -828,7 +828,7 @@ The following additional resources may be of assistance: * [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) * [core-validate-commit](https://github.com/evanlucas/core-validate-commit) - A utility that ensures commits follow the commit formatting guidelines. -* How to respectfully and usefully review code part [one](https://mtlynch.io/human-code-reviews-1/) and [two](https://mtlynch.io/human-code-reviews-2/) +* How to respectfully and usefully review code, part [one](https://mtlynch.io/human-code-reviews-1/) and [two](https://mtlynch.io/human-code-reviews-2/) * [How to write a positive code review](https://css-tricks.com/code-review-etiquette/) From 4ced00784b2f6c832a3a068c54df4cf3e95bf2b4 Mon Sep 17 00:00:00 2001 From: Salame William Date: Fri, 29 Dec 2017 15:41:06 +0100 Subject: [PATCH 3/3] doc: moved links about PR communication to COLLABORATOR_GUIDE.md Moved a few links about PR communication from CONTRIBUTING.md to COLLABORATOR_GUIDE.md --- COLLABORATOR_GUIDE.md | 5 +++++ CONTRIBUTING.md | 2 -- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index baaf270247d32c..21eb9a872e409e 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -116,6 +116,11 @@ oppose the PR, it can be landed. Where there is disagreement among TSC members or objections from one or more Collaborators, `semver-major` pull requests should be put on the TSC meeting agenda. +#### Helpful resources + +* How to respectfully and usefully review code, part [one](https://mtlynch.io/human-code-reviews-1/) and [two](https://mtlynch.io/human-code-reviews-2/) +* [How to write a positive code review](https://css-tricks.com/code-review-etiquette/) + ### Waiting for Approvals Before landing pull requests, sufficient time should be left for input diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd63ce63ad84e7..d27959c6dc5dbd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -828,8 +828,6 @@ The following additional resources may be of assistance: * [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) * [core-validate-commit](https://github.com/evanlucas/core-validate-commit) - A utility that ensures commits follow the commit formatting guidelines. -* How to respectfully and usefully review code, part [one](https://mtlynch.io/human-code-reviews-1/) and [two](https://mtlynch.io/human-code-reviews-2/) -* [How to write a positive code review](https://css-tricks.com/code-review-etiquette/) ## Developer's Certificate of Origin 1.1