Skip to content

Commit a225f99

Browse files
Trotttargos
authored andcommitted
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: #25975 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent f4cfbf4 commit a225f99

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

COLLABORATOR_GUIDE.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -292,25 +292,23 @@ metadata. Raise a Pull Request like any other change.
292292

293293
### Introducing New Modules
294294

295-
Semver-minor commits that introduce new core modules should be treated with
296-
extra care.
295+
Treat commits that introduce new core modules with extra care.
297296

298-
The name of the new core module should not conflict with any existing
299-
module in the ecosystem unless a written agreement with the owner of those
300-
modules is reached to transfer ownership.
297+
Check if the module's name conflicts with an existing ecosystem module. If it
298+
does, choose a different name unless the module owner has agreed in writing to
299+
transfer it.
301300

302-
If the new module name is free, a Collaborator should register a placeholder
303-
in the module registry as soon as possible, linking to the pull request that
304-
introduces the new core module.
301+
If the new module name is free, register a placeholder in the module registry as
302+
soon as possible. Link to the pull request that introduces the new core module
303+
in the placeholder's `README`.
305304

306-
Pull requests introducing new core modules:
305+
For pull requests introducing new core modules:
307306

308-
* Must be left open for at least one week for review.
309-
* Must be labeled using the `tsc-review` label.
310-
* Must have signoff from at least two TSC members.
311-
312-
New core modules must be landed with a [Stability Index][] of Experimental,
313-
and must remain Experimental until a semver-major release.
307+
* Allow at least one week for review.
308+
* Label with the `tsc-review` label.
309+
* Land only after sign-off from at least two TSC members.
310+
* Land with a [Stability Index][] of Experimental. The module must remain
311+
Experimental until a semver-major release.
314312

315313
### Additions to N-API
316314

0 commit comments

Comments
 (0)