Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 2f99461

Browse filesBrowse files
mhdawsonRafaelGSS
authored andcommitted
doc: update guidance for adding new modules
- updated based on decision to use node: prefix in nodejs/TSC#1206 - updated based on agreement in TSC meeting on adding /promises to existing modules as per minutes - nodejs/TSC#1281 Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #44576 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Beth Griggs <bethanyngriggs@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Danielle Adams <adamzdanielle@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent dda556d commit 2f99461
Copy full SHA for 2f99461

File tree

Expand file treeCollapse file tree

1 file changed

+14
-6
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+14
-6
lines changed
Open diff view settings
Collapse file

‎doc/contributing/collaborator-guide.md‎

Copy file name to clipboardExpand all lines: doc/contributing/collaborator-guide.md
+14-6Lines changed: 14 additions & 6 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -392,13 +392,21 @@ metadata. Raise a pull request like any other change.
392392

393393
Treat commits that introduce new core modules with extra care.
394394

395-
Check if the module's name conflicts with an existing ecosystem module. If it
396-
does, choose a different name unless the module owner has agreed in writing to
397-
transfer it.
395+
New modules must only be added with the `node:` prefix.
398396

399-
If the new module name is free, register a placeholder in the module registry as
400-
soon as possible. Link to the pull request that introduces the new core module
401-
in the placeholder's `README`.
397+
When adding promises to an existing API, add `/promises`
398+
(`inspector/promises`, etc.). Apply the `semver-major` label to the addition.
399+
400+
If the new module name is free in npm, register
401+
a placeholder in the module registry as soon as possible. Link to the pull
402+
request that introduces the new core module in the placeholder's `README`.
403+
404+
If the module name is not free and the module is
405+
not widely used, contact the owner to see if they would be willing to transfer
406+
it to the project.
407+
408+
We register a placeholder without the `node:` prefix whenever
409+
possible to avoid confusion and typosquatting attacks.
402410

403411
For pull requests introducing new core modules:
404412

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.