-
-
Notifications
You must be signed in to change notification settings - Fork 34.3k
doc: update guidance for adding new modules #44576
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.
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
Closed
Closed
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
b4b1ced
doc: update guidance for adding new modules
mhdawson 9b3ae9a
squash:fixup
mhdawson e82833b
Update doc/contributing/collaborator-guide.md
Trott 347453e
Update doc/contributing/collaborator-guide.md
Trott 621a8b0
Update doc/contributing/collaborator-guide.md
Trott d129114
Update doc/contributing/collaborator-guide.md
Trott af6919e
Update doc/contributing/collaborator-guide.md
Trott a9fe2fe
Update doc/contributing/collaborator-guide.md
mhdawson 0b19d4e
Update doc/contributing/collaborator-guide.md
mhdawson c524819
Update doc/contributing/collaborator-guide.md
mhdawson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -392,13 +392,21 @@ metadata. Raise a pull request like any other change. | |
|
|
||
| Treat commits that introduce new core modules with extra care. | ||
|
|
||
| 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. | ||
| New modules must be added with the `node:` prefix. | ||
mhdawson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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`. | ||
| When adding promises to an existing API, add `/promises` (`inspector/promises`, etc.). | ||
Trott marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Apply the `semver-major` label to the addition. | ||
|
|
||
| If the new module name without the `node:` prefix 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`. | ||
|
|
||
| If the module name without the `node:` prefix is not free and the module is | ||
|
||
| not widely used, contact the owner to see if they would be willing to transfer | ||
| it to the project. | ||
|
|
||
targos marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| We try to register a placeholder without the `node:` prefix whenever | ||
Trott marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| possible to avoid confusion and typosquatting attacks. | ||
|
|
||
| For pull requests introducing new core modules: | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line is a little ambiguous. Are you saying based on the TSC vote that new modules should be available only with the
node:prefix? If so, I think we should clarify that point (since core modules are already available with thenode:prefix by default).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cjihrig thanks, incorporated this and your other comments.