Skip to content

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

Open
aduh95 wants to merge 1 commit into
nodejs:mainfrom
aduh95:introducing-new-modules
Open

doc: clarify rules for adding new built-in modules#64648
aduh95 wants to merge 1 commit into
nodejs:mainfrom
aduh95:introducing-new-modules

Conversation

@aduh95

@aduh95 aduh95 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

We've added the node: prefix requirement to avoid the semver-major requirement for new modules (well I don't remember if it was the intent, but it's definitely the consequence of it). In #62066 (comment), @jasnell marked the PR introducing node:stream/iter as semver-major PRs that contain breaking changes and should be released in the next major version. , but I'd argue that it doesn't make sense to treat as semver-major a new prefixed module (i.e. it cannot shadow a user package) that's behind a runtime flag anyways. EDIT: it's not actually prefix-only, require('stream/iter') === require(node:stream/iter') – but still, because it's opt-in I think my point still stands.

In the case of node:stream/iter, not backporting it is blocking a number of backports on Node.js 24, which cascades into creating more conflicts on unrelated backports, which is a big maintenance burden

Signed-off-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jul 21, 2026
@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Jul 21, 2026

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 varient of an existing API (e.g.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When adding a "sub-module", e.g. a promise varient of an existing API (e.g.
When adding a "sub-module", e.g. a promise variant of an existing API (e.g.

@jasnell

jasnell commented Jul 21, 2026

Copy link
Copy Markdown
Member

And I'm +1 on retroactively changing the stream/iter to semver-minor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants