Skip to content

Commit

Permalink
doc: revise Introducing New Modules
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Trott authored and targos committed Feb 10, 2019
1 parent f4cfbf4 commit a225f99
Showing 1 changed file with 13 additions and 15 deletions.
28 changes: 13 additions & 15 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit a225f99

Please sign in to comment.