doc: revise Introducing New Modules #25975
Conversation
Revise "Introducing New Modules" in the Collaborator Guide: * Improve clarity. * Remove passive voice. * Keep sentences short for ease of reading/scanning.
Trott
added
the
author ready
| @@ -292,25 +292,23 @@ metadata. Raise a Pull Request like any other change. | |||
|
|
|||
| ### Introducing New Modules | |||
|
|
|||
| Semver-minor commits that introduce new core modules should be treated with | |||
| extra care. | |||
| Treat commits that introduce new core modules with extra care. | |||
There was a problem hiding this comment.
Is it mentioned elsewhere that introducing a new core module is semver-minor?
There was a problem hiding this comment.
Not as far as I know. If it's desirable to have it here, I can add a sentence. I'd prefer to leave it out as it's self-evident and low-value (as someone else will certainly add the label if the author does not) and this doc is plenty long as it is. But I don't have a strong preference, so I'll yield if a Collaborator thinks it needs to be in there.
There was a problem hiding this comment.
I don't really have a strong preference either. I guess if we do mention it it can go in the bullet list below (probably next to "Label with the tsc-review label.").
There was a problem hiding this comment.
By definition it adds functionality, ergo, semver-minor.
Revise "Introducing New Modules" in the Collaborator Guide: * Improve clarity. * Remove passive voice. * Keep sentences short for ease of reading/scanning. PR-URL: nodejs#25975 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
|
Landed in 016c7b9 |
Revise "Introducing New Modules" in the Collaborator Guide: * Improve clarity. * Remove passive voice. * Keep sentences short for ease of reading/scanning. PR-URL: #25975 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Revise "Introducing New Modules" in the Collaborator Guide:
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes