doc: edit CONTRIBUTING.md for clarity etc. #12796
Conversation
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
I would be okay with keeping this line
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
IMHO move this whole section (#### Dependencies) leave just this line with a bullet point.
Should find a better place for it.
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
“A commit log should describe what changed and why” is still good advice, at least in theory…
There was a problem hiding this comment.
Maybe we can keep this doc very succinct and put a link right at the top with something like "if you are new or relatively new to contributing to open source, check out this way more informative guide". The link would be to a guide with more general information like this? And it could go into lots of detail, including maybe even some of the stuff from #12744 and material like that?
|
👍 for the initiative! |
CONTRIBUTING.md
Outdated
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
IMHO move this whole section (#### Dependencies) leave just this line with a bullet point.
Should find a better place for it.
CONTRIBUTING.md
Outdated
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
I suggest move all the technical stuff except make test / vcbuild test to a new HOWTO test.md
CONTRIBUTING.md
Outdated
mscdex
added
the
meta
PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Landed in 0258aed |
PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Doesn't land cleanly (probably relies on something else that wasn't backported). I'm assuming there's no real need to raise a backport PR (although if anyone wants to backport it then feel free). |
7 participants
Minor improvements to CONTRIBUTING.md.
Checklist
Affected core subsystem(s)
doc