doc: split CONTRIBUTING.md #18271
doc: split CONTRIBUTING.md #18271
Conversation
|
Added another commit to fix the external references to CONTRIBUTING.md cc @Trott @nodejs/documentation |
joyeecheung
force-pushed
the
split-contributing
branch
from
18d607b
to
156d881
Compare
joyeecheung
force-pushed
the
split-contributing
branch
from
156d881
to
9765d56
Compare
|
Thanks for doing that! I have the feeling that additional notes could be in
|
|
@targos Thanks for the review. I have moved additional notes into pull-requests.md. As for the links, I would like to update them in a later PR. The pull-requests.md is still too big and we should probably do a further clean up later. What do you think? |
|
SGTM. Thanks! |
|
@targos Ah, after reading it again I think you are right, they look pretty out-of-the-place like this, we may as well update them now. I have updated the links per your suggestions. Thanks. |
joyeecheung
added
the
author ready
|
Landed in 695ed67, thanks! |
PR-URL: #18271 Fixes: #17842 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
joyeecheung
removed
the
author ready
PR-URL: #18271 Fixes: #17842 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Lands on 8.x but a couple conflict on 6.x. We likely need to backport a bunch of different doc fixes that haven't landed cleanly on 6.x to get this to work so I'm setting it as don't land |
PR-URL: #18271 Fixes: #17842 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
@MylesBorins is there any reason why files like CONTRIBUTING.md (and the readme, and COLLABORATOR_GUIDE etc) need to be backported at all? |
PR-URL: nodejs#18271 Fixes: nodejs#17842 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
I wanted to update the CONTRIBUTING.md with some notes on CI flakes, but seeing how big it is I decided to split it first. It is already too long to read.
The first commit split the CONTRIBUTING.md into separate documents. No changes are made to the text of each section other than relative link fixes.
The second commit improves the summaries in CONTRIBUTING.md.
Fixes: #17842
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc