Skip to content

doc: clarify rules for adding new built-in modules #64648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aduh95 wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −3
Open

doc: clarify rules for adding new built-in modules #64648

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
003e2c2
doc: clarify rules for adding new built-in modules
aduh95 Jul 21, 2026
c75d5a0
fixup! doc: clarify rules for adding new built-in modules
aduh95 Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions doc/contributing/collaborator-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,10 +443,12 @@ metadata. Raise a pull request like any other change.

Treat commits that introduce new core modules with extra care.

New modules must only be added with the `node:` prefix.
New modules must only be added with the `node:` prefix, as `semver-minor`.

When adding promises to an existing API, add `/promises`
(`inspector/promises`, etc.). Apply the `semver-major` label to the addition.
When adding a "sub-module", e.g. a promise variant of an existing API (e.g.
`node:inspector/promises`) that is available without the `node:` prefix, making
the sub-module available without the prefix is possible behind a runtime flag,
or as a `semver-major` change.

If the new module name is free in npm, register
a placeholder in the module registry as soon as possible. Link to the pull
Expand Down
Loading