doc: edit CONTRIBUTING.md for clarity etc. #12796
Conversation
| [GOVERNANCE.md](./GOVERNANCE.md) document for more information about how this | ||
| works. | ||
|
|
||
| This document will guide you through the contribution process. |
There was a problem hiding this comment.
I would be okay with keeping this line
There was a problem hiding this comment.
I'm with @Trott less is more.
CONTRIBUTING.md
Outdated
| directories that are not part of the project proper. Any changes to files | ||
| in those directories or its subdirectories should be sent to their respective | ||
| projects. Do not send a patch to Node.js. We cannot accept such patches. | ||
| directories that are not part of the project proper. Changes to files in those directories should be sent to their respective projects. Do not send a patch to |
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
| ### Commit guidelines | ||
|
|
||
| Writing good commit logs is important. A commit log should describe what | ||
| changed and why. Follow these guidelines when writing one: |
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! |
| [GOVERNANCE.md](./GOVERNANCE.md) document for more information about how this | ||
| works. | ||
|
|
||
| This document will guide you through the contribution process. |
There was a problem hiding this comment.
I'm with @Trott less is more.
CONTRIBUTING.md
Outdated
| directories that are not part of the project proper. Any changes to files | ||
| in those directories or its subdirectories should be sent to their respective | ||
| projects. Do not send a patch to Node.js. We cannot accept such patches. | ||
| directories that are not part of the project proper. Changes to files in those directories should be sent to their respective projects. Do not send a patch to |
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
| ### Commit guidelines | ||
|
|
||
| Writing good commit logs is important. A commit log should describe what | ||
| changed and why. Follow these guidelines when writing one: |
|
|
||
| To run the tests on Unix / macOS: | ||
| To run the tests (including code linting) on Unix / macOS: |
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
| @@ -208,7 +188,7 @@ Pull requests are usually reviewed within a few days. | |||
| ### Step 7: Discuss and update | |||
|
|
|||
| You will probably get feedback or requests for changes to your Pull Request. | |||
| This is a big part of the submission process so don't be disheartened! | |||
| This is a big part of the submission process so don't be discouraged! | |||
|
|
|||
| To make changes to an existing Pull Request, make the changes to your branch. | |||
mscdex
added
the
meta
PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 0258aed |
PR-URL: nodejs#12796 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
|
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). |
Minor improvements to CONTRIBUTING.md.
Checklist
Affected core subsystem(s)
doc