同步操作将从 weolar/mininodejs20 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
This document explains how collaborators manage the Node.js project. Collaborators should understand the guidelines for new contributors and the project governance model.
Mind these guidelines, the opinions of other collaborators, and guidance of the TSC. Notify other qualified parties for more input on an issue or a pull request. See Who to CC in the issue tracker.
Always show courtesy to individuals submitting issues and pull requests. Be welcoming to first-time contributors, identified by the GitHub badge.
For first-time contributors, check if the commit author is the same as the pull request author. This way, once their pull request lands, GitHub will show them as a Contributor. Ask if they have configured their git username and email to their liking.
Collaborators can close any issue or pull request that is not relevant to the future of the Node.js project. Where this is unclear, leave the issue or pull request open for several days to allow for discussion. Where this does not yield evidence that the issue or pull request has relevance, close it. Remember that issues and pull requests can always be re-opened if necessary.
A pull request is author ready when:
Please always add the author ready
label to the pull request in that case.
Please always remove it again as soon as the conditions are not met anymore.
When you open a pull request, start a CI right away. Later, after new code changes or rebasing, start a new CI.
As soon as the pull request is ready to land, please do so. This allows other
collaborators to focus on other pull requests. If your pull request is not ready
to land but is author ready, add the
author ready
label. If you wish to land the pull request yourself, use the
"assign yourself" link to self-assign it.
Use the process outlined in SECURITY.md to report security issues. If a user opens a security issue in the public repository:
premature-disclosures
repository. Add a copy of the patch for the
pull request to the issue. Add screenshots of discussion from the pull request
to the issue.FYI - pull request deleted #YYYY
. Include an explanation for the user:
FYI @xxxx we asked GitHub to delete your pull request while we work on releases in private.
tsc@iojs.org
with links to the issues in the
premature-disclosures
repository.Contributors propose modifications to Node.js using GitHub pull requests. This includes modifications proposed by TSC members and other collaborators. A pull request must pass code review and CI before landing into the codebase.
At least two collaborators must approve a pull request before the pull request lands. One collaborator approval is enough if the pull request has been open for more than seven days.
Approving a pull request indicates that the collaborator accepts responsibility for the change.
Approval must be from collaborators who are not authors of the change.
In some cases, it might be necessary to summon a GitHub team to a pull request for review by @-mention. See Who to CC in the issue tracker.
If you are the first collaborator to approve a pull request that has no CI yet, please start one. Please also start a new CI if the pull request creator pushed new code since the last CI run.
A pull request can land if it has the needed approvals,
CI, wait time and no
outstanding objections. Breaking changes
must receive TSC review in addition to other
requirements. If a pull request meets all requirements except the
wait time, please add the
author ready
label.
Collaborators can object to a pull request by using the "Request Changes" GitHub feature. Dissent comments alone don't constitute an objection. Any pull request objection must include a clear reason for that objection, and the objector must remain responsive for further discussion towards consensus about the direction of the pull request. Where possible, provide a set of actionable steps alongside the objection.
If the objection is not clear to others, another collaborator can ask an objecting collaborator to explain their objection or to provide actionable steps to resolve the objection. If the objector is unresponsive for seven days after a collaborator asks for clarification, a collaborator may dismiss the objection.
Pull requests with outstanding objections must remain open until all
objections are satisfied. If reaching consensus is not possible, a
collaborator can escalate the issue to the TSC by pinging @nodejs/tsc
and
adding the tsc-agenda
label to the issue.
Before landing pull requests, allow 48 hours for input from other collaborators. Certain types of pull requests can be fast-tracked and can land after a shorter delay. For example:
code-and-learn
tasks often fall into this category.good-first-issue
pull requests might also be suitable.To propose fast-tracking a pull request, apply the fast-track
label. Then a
GitHub Actions workflow will add a comment that collaborators can upvote.
If someone disagrees with the fast-tracking request, remove the label. Do not fast-track the pull request in that case.
The pull request can be fast-tracked if two collaborators approve the fast-tracking request. To land, the pull request itself still needs two collaborator approvals and a passing CI.
Collaborators can request fast-tracking of pull requests they did not author. In that case only, the request itself is also one fast-track approval. Upvote the comment anyway to avoid any doubt.
All fixes must have a test case which demonstrates the defect. The test should fail before the change, and pass after the change.
Do not land any pull requests without the necessary passing CI runs.
A passing (green) GitHub Actions CI result is required. A passing (green or
yellow) Jenkins CI is also required if the pull
request contains changes that will affect the node
binary. This is because
GitHub Actions CI does not cover all the environments supported by Node.js.
Changes in the following folders (except comment-only changes) are guaranteed to
affect the node
binary:
deps/
lib/
src/
test/
tools/code_cache/
tools/gyp/
tools/icu/
tools/inspector-protocol/
tools/msvs/
tools/snapshot/
tools/v8_gypfiles/
There are some other files that touch the build chain. Changes in the following
files also qualify as affecting the node
binary:
tools/*.py
tools/build-addons.mjs
*.gyp
*.gypi
configure
configure.py
Makefile
vcbuild.bat
If there are GitHub Actions CI failures unrelated to the change in the pull request, try the "🔄 Re-run all jobs" button, on the right-hand side of the "Checks" tab.
If there are Jenkins CI failures unrelated to the change in the pull request,
try "Resume Build". It is in the left navigation of the relevant
node-test-pull-request
job. It will preserve all the green results from the
current job but re-run everything else. Start a fresh CI if more than seven days
have elapsed since the original failing CI as the compiled binaries for the
Windows and ARM platforms are only kept for seven days.
If new commits are pushed to the pull request branch after the latest Jenkins
CI run, a fresh CI run is required. It can be started by pressing "Retry" on
the left sidebar, or by adding the request-ci
label to the pull request.
node-test-pull-request
is the CI job to test pull requests. It runs the build-ci
and test-ci
targets on all supported platforms.
citgm-smoker
uses CitGM
to allow you to run
npm install && npm test
on a large selection of common modules. This is
useful to check whether a change will cause breakage in the ecosystem.
node-stress-single-test
can run a group of tests over and over on a specific platform. Use it to check
that the tests are reliable.
node-test-commit-v8-linux
runs the standard V8 tests. Run it when updating V8 in Node.js or floating new
patches on V8.
node-test-commit-custom-suites-freestyle
enables customization of test suites and parameters. It can execute test
suites not used in other CI test runs (such as tests in the internet
or
pummel
directories). It can also make sure tests pass when provided with a
flag not used in other CI test runs (such as --worker
).
From the CI Job page, click "Build with Parameters" on the left side.
You generally need to enter only one or both of the following options in the form:
GIT_REMOTE_REF
: Change to the remote portion of git refspec.
To specify the branch this way, refs/heads/BRANCH
is used
(e.g. for main
-> refs/heads/main
).
For pull requests, it will look like refs/pull/PR_NUMBER/head
(e.g. for pull request #42 -> refs/pull/42/head
).REBASE_ONTO
: Change that to origin/main
so the pull request gets rebased
onto main
. This can especially be important for pull requests that have been
open a while.Look at the list of jobs on the left hand side under "Build History" and copy the link to the one you started (which will be the one on top, but click through to make sure it says something like "Started 5 seconds ago" (top right) and "Started by user ...".
Copy/paste the URL for the job into a comment in the pull request.
node-test-pull-request
is an exception where the GitHub bot will automatically post for you.
The node-test-pull-request
CI job can be started by adding the request-ci
label into the pull request.
Once this label is added, github-actions bot
will start
the node-test-pull-request
automatically. If the github-actions bot
is unable to start the job, it will update the label with request-ci-failed
.
All functionality in the official Node.js documentation is part of the public API. Any undocumented object, property, method, argument, behavior, or event is internal. There are exceptions to this rule. Node.js users have come to rely on some undocumented behaviors. Collaborators treat many of those undocumented behaviors as public.
All undocumented functionality exposed via process.binding(...)
is internal.
All undocumented functionality in lib/internal/**/*.js
is internal. It is
public, though, if it is re-exported by code in lib/*.js
.
Non-exported Symbol
properties and methods are internal.
Any undocumented object property or method that begins with _
is internal.
Any native C/C++ APIs/ABIs requiring the NODE_WANT_INTERNALS
flag are
internal.
Sometimes, there is disagreement about whether functionality is internal or public. In those cases, the TSC makes a determination.
For undocumented APIs that are public, open a pull request documenting the API.
At least two TSC members must approve backward-incompatible changes to the
main
branch.
Examples of breaking changes include:
Existing stable public APIs that change in a backward-incompatible way must undergo deprecation. The exceptions to this rule are:
For more information, see Deprecations.
Breaking changes to internal elements can occur in semver-patch or semver-minor commits. Take significant care when making and reviewing such changes. Make an effort to determine the potential impact of the change in the ecosystem. Use Canary in the Goldmine to test such changes. If a change will cause ecosystem breakage, then it is semver-major. Consider providing a Public API in such cases.
Sometimes, a change intended to be non-breaking turns out to be a breaking
change. If such a change lands on the main
branch, a collaborator can revert
it. As an alternative to reverting, the TSC can apply the semver-major label
after-the-fact.
Revert commits with git revert <HASH>
or git revert <FROM>..<TO>
. The
generated commit message will not have a subsystem and might violate line length
rules. That is OK. Append the reason for the revert and any Refs
or Fixes
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.
When adding promises to an existing API, add /promises
(inspector/promises
, etc.). Apply the semver-major
label to the addition.
If the new module name is free in npm, 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 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.
We register a placeholder without the node:
prefix whenever
possible to avoid confusion and typosquatting attacks.
For pull requests introducing new core modules:
Node-API provides an ABI-stable API guaranteed for future Node.js versions.
Node-API additions call for unusual care and scrutiny. If a change adds to
node_api.h
, js_native_api.h
, node_api_types.h
, or js_native_api_types.h
,
consult the relevant guide.
Node.js uses three Deprecation levels. For all deprecated APIs, the API documentation must state the deprecation status.
Documentation-Only Deprecation
--pending-deprecation
flag or
NODE_PENDING_DEPRECATION
environment variable.Runtime Deprecation
--throw-deprecation
flag, will throw a runtime error.End-of-Life
Apply the notable-change
label to all pull requests that introduce
Documentation-Only Deprecations. Such deprecations have no impact on code
execution. Thus, they are not breaking changes (semver-major
).
Runtime Deprecations and End-of-Life APIs (internal or public) are breaking
changes (semver-major
). The TSC can make exceptions, deciding that one of
these deprecations is not a breaking change.
Avoid Runtime Deprecations when an alias or a stub/no-op will suffice. An alias or stub will have lower maintenance costs for end users and Node.js core.
All deprecations receive a unique and immutable identifier. Documentation, warnings, and errors use the identifier when referring to the deprecation. The documentation for the deprecation identifier must always remain in the API documentation. This is true even if the deprecation is no longer in use (for example, due to removal of an End-of-Life deprecated API).
A deprecation cycle is a major release during which an API has been in one of the three Deprecation levels. Documentation-Only Deprecations can land in a minor release. They can not change to a Runtime Deprecation until the next major release.
No API can change to End-of-Life without going through a Runtime Deprecation cycle. There is no rule that deprecated code must progress to End-of-Life. Documentation-Only and Runtime Deprecations can remain in place for an unlimited duration.
Communicate pending deprecations and associated mitigations with the ecosystem
as soon as possible. If possible, do it before the pull request adding the
deprecation lands on the main
branch.
Use the notable-change
label on pull requests that add or change the
deprecation level of an API.
Collaborators can opt to elevate pull requests or issues to the TSC. Do this if a pull request or issue:
semver-major
, or@-mention the @nodejs/tsc
GitHub team if you want to elevate an issue to the
TSC. Do not use the GitHub UI on the right-hand side to assign to
@nodejs/tsc
or request a review from @nodejs/tsc
.
The TSC serves as the final arbiter where required.
For pull requests from first-time contributors, be welcoming. Also, verify that their git settings are to their liking.
All commits should be self-contained, meaning every commit should pass all tests. This makes it much easier when bisecting to find a breaking change.
See the commit queue guide.
git-node
In most cases, using the git-node
command of node-core-utils
is enough to land a pull request. If you discover a problem when using
this tool, please file an issue to the issue tracker.
Quick example:
$ npm install -g node-core-utils
$ git node land $PRID
To use node-core-utils
, you will need a GitHub access token. If you do not
have one, node-core-utils
will create one for you the first time you use it.
To do this, it will ask for your GitHub password and two-factor authentication
code. If you wish to create the token yourself in advance, see
the node-core-utils
guide.
Infrequently, it is necessary to manually perform the steps required to land a
pull request rather than rely on git-node
.
Clear any am
/rebase
that might already be underway:
$ git am --abort
$ git rebase --abort
Checkout proper target branch:
$ git checkout main
Update the tree (assumes your repository is set up as detailed in CONTRIBUTING.md):
$ git fetch upstream
$ git merge --ff-only upstream/main
Apply external patches:
$ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am --whitespace=fix
If the merge fails even though recent CI runs were successful, try a 3-way merge:
$ git am --abort
$ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am -3 --whitespace=fix
If the 3-way merge succeeds, check the results against the original pull request. Build and test on at least one platform before landing.
If the 3-way merge fails, then it is most likely that a conflicting pull request has landed since the CI run. You will have to ask the author to rebase.
Check and re-review the changes:
$ git diff upstream/main
Check the number of commits and commit messages:
$ git log upstream/main...main
Squash commits and add metadata:
$ git rebase -i upstream/main
This will open a screen like this (in the default shell editor):
pick 6928fc1 crypto: add feature A
pick 8120c4c add test for feature A
pick 51759dc crypto: feature B
pick 7d6f433 test for feature B
# Rebase f9456a2..7d6f433 onto f9456a2
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into previous commit
# f, fixup = like "squash", but discard this commit's log message
# x, exec = run command (the rest of the line) using shell
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out
Replace a couple of pick
s with fixup
to squash them into a
previous commit:
pick 6928fc1 crypto: add feature A
fixup 8120c4c add test for feature A
pick 51759dc crypto: feature B
fixup 7d6f433 test for feature B
Replace pick
with reword
to change the commit message:
reword 6928fc1 crypto: add feature A
fixup 8120c4c add test for feature A
reword 51759dc crypto: feature B
fixup 7d6f433 test for feature B
Save the file and close the editor. When prompted, enter a new commit message for that commit. This is an opportunity to fix commit messages.
The commit message text must conform to the commit message guidelines.
Change the original commit message to include metadata. (The
git node metadata
command can generate the metadata
for you).
PR-URL:
line that references the full GitHub URL of the pull
request. This makes it easy to trace a commit back to the conversation that
led up to that change.Fixes: X
line, where X is the full GitHub URL for an
issue. A commit message can include more than one Fixes:
lines.Refs:
lines referencing a URL for any relevant
background.Reviewed-By: Name <email>
line for each collaborator who
reviewed the change.
Other changes might have landed on main
since the successful CI run. As a
precaution, run tests (make -j4 test
or vcbuild test
).
Confirm that the commit message format is correct using core-validate-commit.
$ git rev-list upstream/main...HEAD | xargs core-validate-commit
Optional: For your own commits, force push the amended commit to the pull
request branch. If your branch name is bugfix
, then:
git push --force-with-lease origin main:bugfix
. Don't close the pull
request. It will close after you push it upstream. It will have the purple
merged status rather than the red closed status. If you close the pull request
before GitHub adjusts its status, it will show up as a 0 commit pull
request with no changed files. The order of operations is important.
If you push upstream before you push to your branch, GitHub will close
the issue with the red closed status.
Time to push it:
$ git push upstream main
Close the pull request with a "Landed in <commit hash>
" comment. Even if
your pull request shows the purple merged status,
add the "Landed in <commit hash>..<commit hash>" comment if you added
more than one commit.
Sometimes, when running git push upstream main
, you might get an error
message like this:
To https://github.com/nodejs/node
! [rejected] main -> main (fetch first)
error: failed to push some refs to 'https://github.com/nodejs/node'
hint: Updates were rejected because the tip of your current branch is behind
hint: its remote counterpart. Integrate the remote changes (e.g.
hint: 'git pull ...') before pushing again.
hint: See the 'Note about fast-forwards' in 'git push --help' for details.
That means a commit has landed since your last rebase against upstream/main
.
To fix this, pull with rebase from upstream, run the tests again, and (if the
tests pass) push again:
git pull upstream main --rebase
make -j4 test
git push upstream main
git
, there's a way to override remote trees by force pushing
(git push -f
). This is generally forbidden as it creates conflicts in other
people's forks. It is permissible for simpler slip-ups such as typos in commit
messages. You are only allowed to force push to any Node.js branch within 10
minutes from your original push. If someone else pushes to the branch or the
10-minute period passes, consider the commit final.
--force-with-lease
to reduce the chance of overwriting someone else's
change.Long Term Support (LTS) guarantees 30-month support cycles for specific Node.js versions. You can find more information in the full release plan. Once a branch enters LTS, the release plan limits the types of changes permitted in the branch.
Each LTS release has a corresponding branch (v10.x, v8.x, etc.). Each also has a corresponding staging branch (v10.x-staging, v8.x-staging, etc.).
Commits that land on main
are cherry-picked to each staging branch as
appropriate. If a change applies only to the LTS branch, open the pull request
against the staging branch. Commits from the staging branch land on the LTS
branch only when a release is being prepared. They might land on the LTS branch
in a different order than they do in staging.
Only members of @nodejs/backporters should land commits onto LTS staging branches.
When you send your pull request, please state if your change is breaking. Also state if you think your patch is a good candidate for backporting. For more information on backporting, please see the backporting guide.
There are several LTS-related labels:
lts-watch-
labels are for pull requests to consider for landing in staging
branches. For example, lts-watch-v10.x
would be for a change
to consider for the v10.x-staging
branch.
land-on-
are for pull requests that should land in a future v*.x
release. For example, land-on-v10.x
would be for a change to land in Node.js
10.x.
Any collaborator can attach these labels to any pull request/issue. As commits
land on the staging branches, the backporter removes the lts-watch-
label.
Likewise, as commits land in an LTS release, the releaser removes the land-on-
label.
Attach the appropriate lts-watch-
label to any pull request that
might impact an LTS release.
Subsystem | Maintainers |
---|---|
benchmark/* |
@nodejs/benchmarking, @mscdex |
doc/* , *.md
|
@nodejs/documentation |
lib/assert |
@nodejs/assert |
lib/async_hooks |
@nodejs/async_hooks for bugs/reviews (+ @nodejs/diagnostics for API) |
lib/buffer |
@nodejs/buffer |
lib/child_process |
@nodejs/child_process |
lib/cluster |
@nodejs/cluster |
lib/{crypto,tls,https} |
@nodejs/crypto |
lib/dgram |
@nodejs/dgram |
lib/domains |
@nodejs/domains |
lib/fs , src/{fs,file}
|
@nodejs/fs |
lib/{_}http{*} |
@nodejs/http |
lib/inspector.js , src/inspector_*
|
@nodejs/v8-inspector |
lib/internal/bootstrap/* |
@nodejs/process |
lib/internal/url , src/node_url
|
@nodejs/url |
lib/net |
@bnoordhuis, @indutny, @nodejs/streams |
lib/repl |
@nodejs/repl |
lib/{_}stream{*} |
@nodejs/streams |
lib/timers |
@nodejs/timers |
lib/util |
@nodejs/util |
lib/zlib |
@nodejs/zlib |
src/async_wrap.* |
@nodejs/async_hooks |
src/node_api.* |
@nodejs/node-api |
src/node_crypto.* , src/crypto
|
@nodejs/crypto |
test/* |
@nodejs/testing |
tools/node_modules/eslint , .eslintrc
|
@nodejs/linting |
build | @nodejs/build |
src/module_wrap.* , lib/internal/modules/* , lib/internal/vm/module.js
|
@nodejs/modules |
GYP | @nodejs/gyp |
performance | @nodejs/performance |
platform specific | @nodejs/platform-{aix,arm,freebsd,macos,ppc,smartos,s390,windows,windows-arm} |
python code | @nodejs/python |
upgrading c-ares | @rvagg |
upgrading http-parser | @nodejs/http, @nodejs/http2 |
upgrading libuv | @nodejs/libuv |
upgrading npm | @nodejs/npm |
upgrading V8 | @nodejs/V8, @nodejs/post-mortem |
Embedded use or delivery of Node.js | @nodejs/delivery-channels |
When things need extra attention, are controversial, or semver-major
:
@nodejs/tsc
If you cannot find who to cc for a file, git shortlog -n -s <file>
can help.
confirmed-bug
: Bugs you have verifieddiscuss
: Things that need larger discussionfeature request
: Any issue that requests a new featuregood first issue
: Issues suitable for newcomers to fixmeta
: Governance, policies, procedures, etc.tsc-agenda
: Open issues and pull requests with this label will be added to
the Technical Steering Committee meeting agendaauthor-ready
- A pull request is author ready when:
Please always add the author ready
label to pull requests that qualify.
Please always remove it again as soon as the conditions are not met anymore,
such as if the CI run fails or a new outstanding review comment is posted.
semver-{minor,major}
We use labels to keep track of which branches a commit should land on:
dont-land-on-v?.x
land-on-v?.x
backport-requested-v?.x
dont-land-on-v?.x
or backported-to-v?.x
backported-to-v?.x
lts-watch-v?.x
release-agenda
v?.x
main
but rather the
v?.x-staging
branchOnce a release line enters maintenance mode, the corresponding labels do not need to be attached anymore, as only important bugfixes will be included.
macos
, windows
, smartos
, aix
linux
label because it is the implied defaultarm
, mips
, s390
, ppc
x86{_64}
label because it is the implied default此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。