Node: meta: articles about PR communication

Created on 21 Oct 2017  路  8Comments  路  Source: nodejs/node

Recently, I've come across these articles:

  1. A concise one, concerning more the PR author side:

https://slack.engineering/on-empathy-pull-requests-979e4257d158

  1. An elaborate one, concerning more the PR reviewer side:

https://mtlynch.io/human-code-reviews-1/
https://mtlynch.io/human-code-reviews-2/

I wonder if it is worth to find a place for referencing them in the CONTRIBUTING.md and COLLABORATOR_GUIDE.md respectively (or in some other more appropriate doc).

P.S. A new one: https://css-tricks.com/code-review-etiquette/

doc good first issue meta

All 8 comments

I really like the second one. 馃憤 The first is a bit heavy handed about putting most of the responsibility on the person opening the PR. Maybe that's applicable to the culture at Slack but it certainly shouldn't be applicable to Node, especially given the number of first-time contributors.

I wonder if it is worth to find a place for referencing them in the CONTRIBUTING.md and COLLABORATOR_GUIDE.md respectively (or in some other more appropriate doc).

SGTM, sounds like a good PR.

@vsemozhetbyt Both the articles are good to connect. Feels like CONTRIBUTING.md (Pull Request section) a good fit to hold this.

+1 to a reference in the collaborators guide.

COLLABORATOR_GUIDE.md is 10 or 15 pages long already. The longer you make it, the less people will read or remember it all.

I'll try to tackle this and include them in the CONTRIBUTING.md and/or the COLLABORATOR_GUIDE.md

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ksushilmaurya picture ksushilmaurya  路  3Comments

srl295 picture srl295  路  3Comments

filipesilvaa picture filipesilvaa  路  3Comments

fanjunzhi picture fanjunzhi  路  3Comments

willnwhite picture willnwhite  路  3Comments