From 7961edbdcb8291c49c4606f7b5b74b81fb04adbd Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 6 Feb 2019 20:36:37 -0800 Subject: [PATCH] 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. --- COLLABORATOR_GUIDE.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 9bfc97147b994b..12b990091491e8 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