diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-02-06 20:36:37 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-02-08 20:46:04 -0800 |
| commit | 016c7b9c32c3f5a06c8cc0e23bd12bb0ba215cda (patch) | |
| tree | 6ac5818c73f7faa9a860a6c45eb1a817af0bacd2 /COLLABORATOR_GUIDE.md | |
| parent | de9d5ff287c576c495f5c132fdf4b826f1356e5a (diff) | |
| download | android-node-v8-016c7b9c32c3f5a06c8cc0e23bd12bb0ba215cda.tar.gz android-node-v8-016c7b9c32c3f5a06c8cc0e23bd12bb0ba215cda.tar.bz2 android-node-v8-016c7b9c32c3f5a06c8cc0e23bd12bb0ba215cda.zip | |
doc: revise Introducing New Modules
Revise "Introducing New Modules" in the Collaborator Guide:
* Improve clarity.
* Remove passive voice.
* Keep sentences short for ease of reading/scanning.
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 9bfc97147b..12b9900914 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -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. -The name of the new core module should not conflict with any existing -module in the ecosystem unless a written agreement with the owner of those -modules is reached to transfer ownership. +Check if the module's name conflicts with an existing ecosystem module. If it +does, choose a different name unless the module owner has agreed in writing to +transfer it. -If the new module name is free, a Collaborator should register a placeholder -in the module registry as soon as possible, linking to the pull request that -introduces the new core module. +If the new module name is free, register a placeholder in the module registry as +soon as possible. Link to the pull request that introduces the new core module +in the placeholder's `README`. -Pull requests introducing new core modules: +For pull requests introducing new core modules: -* Must be left open for at least one week for review. -* Must be labeled using the `tsc-review` label. -* Must have signoff from at least two TSC members. - -New core modules must be landed with a [Stability Index][] of Experimental, -and must remain Experimental until a semver-major release. +* Allow at least one week for review. +* Label with the `tsc-review` label. +* Land only after sign-off from at least two TSC members. +* Land with a [Stability Index][] of Experimental. The module must remain + Experimental until a semver-major release. ### Additions to N-API |