doc: added articles about PR communication in CONTRIBUTING.md #17902
Conversation
Added some references to PR communication articles in Helpful Ressources inside CONTRIBUTING.md Fixes: nodejs#16359
CONTRIBUTING.md
Outdated
| @@ -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/) | |||
There was a problem hiding this comment.
I may be wrong, but do we need a comma or a colon between "code" and "part" here?
vsemozhetbyt
added
the
meta
|
Hi, @vixwilli! Welcome, and thanks for the pull request. I have some questions about whether there might be a better place for this information, but I do appreciate the links! @vsemozhetbyt or anyone else reviewing: Since these linked docs are about reviewing code, don't they more properly belong in the COLLABORATOR_GUIDE.md and not CONTRIBUTING.md? General outlook from me: Our CONTRIBUTING.md is already waaaaaay too long and I'm reluctant to add anything that isn't absolutely essential. Ref: #17842 |
|
@Trott Just a thought: our contributors sometimes also make various brief code notes for each other, so maybe these articles can be helpful for them too. However, I have no strong opinion about the place, so let us hear what others think) |
Added a forgotten comma inside CONTRIBUTING.md
SalameWilliam
force-pushed
the
master
branch
from
5ed74c1 to
670ddfd
Compare
If they're primarily for reviewers, then collaborator guide makes more sense IMO. |
|
+1 on moving this link to the COLLABORATOR_GUIDE.md because the most reviewers of our PR are collaborators. |
|
Where do you think I could put the links inside COLLABORATOR_GUIDE.md ? I initially wanted to put it there but since the guide is more about the technical side of things i didn't really know where to insert it. CONTRIBUTING.md already contains a more "human" side of PR like the articles mentionned and a Helpful Ressources section was already present so it was 'easier' to mention it there |
Moved a few links about PR communication from CONTRIBUTING.md to COLLABORATOR_GUIDE.md
SalameWilliam
force-pushed
the
master
branch
from
39e988e to
4ced007
Compare
|
I placed the links inside COLLABORATOR_GUIDE.md in a specific section since the doc is quite long already and I didn't want to clutter the text with them. Tell me if you see a better spot to link them ! |
I like that location. 👍 |
|
As it appears to be a bit controversial addition, let's wait till Monday before landing, lest anybody have some objections. |
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
|
Landed in d179cca Thank you, @vixwilli! |
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in Helpful Ressources inside COLLABORATOR_GUIDE.md PR-URL: #17902 Fixes: #16359 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Weijia Wang <[email protected]>
Added some references to PR communication articles in
Helpful Ressources inside CONTRIBUTING.md
Fixes: #16359
Checklist
Affected core subsystem(s)
doc, meta