Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
104 commits
Select commit Hold shift + click to select a range
cca0372
timers: allow timers to be used as primitives
lundibundi Jun 19, 2020
aaa6e43
Forces Powershell to use tls1.2
bzoz Jul 21, 2020
093a4b0
test: add tests for validateNumber/validateString
lundibundi Aug 7, 2020
9a7c87d
module: use cjsCache over esm injection
guybedford Aug 3, 2020
7cde699
doc: harden policy around objections
mmarchini Aug 5, 2020
b93ba07
doc: add writable and readable options to Duplex docs
preyunk Jul 15, 2020
2abc98e
build: add flag to build V8 with OBJECT_PRINT
mmarchini Apr 14, 2020
8766b5b
tools: add debug entitlements for macOS 10.15+
ggreco Jul 15, 2020
9527a2a
deps: V8: cherry-pick e06ace6b5cdb
addaleax Aug 7, 2020
27c0653
test: add vm crash regression test
addaleax Aug 7, 2020
77bbd73
util: add debug and debuglog.enabled
bmeck Jun 12, 2020
124a01d
lib: use full URL to GitHub issues in comments
Trott Aug 8, 2020
b261895
test: remove test-child-process-fork-args flaky designation
Trott Aug 8, 2020
d29b805
doc: update http server response 'close' event
renatomariscal Jul 21, 2020
9f0917e
test: use block-scoping in test/pummel/test-timers.js
Trott Aug 5, 2020
fd5153c
test: split test-crypto-dh-hash
Trott Aug 5, 2020
230bcaf
doc: add HPE_UNEXPECTED_CONTENT_LENGTH error description
nikolaykrashnikov Aug 1, 2020
8e91f3e
test: fix test_worker_terminate_finalization
addaleax Aug 11, 2020
91f5324
doc: use semantically appropriate tag for lines
aduh95 Aug 7, 2020
b00f71b
doc: add padding in the sidebar column
aduh95 Aug 7, 2020
3022e0d
src: prefer C++ empty() in boolean expressions
tniessen Jul 19, 2020
ea98122
doc: n-api environment life cycle APIs are stable
jschlight Aug 6, 2020
e4450a1
benchmark: update function_args addon code
addaleax Aug 11, 2020
201d3d7
build: cover all benchmark addons with C++ linter
addaleax Aug 11, 2020
6929649
module: custom --conditions flag option
guybedford Aug 5, 2020
f7563f8
doc: remove typo in crypto.md
Trott Aug 9, 2020
0472d16
test: skip node-api/test_worker_terminate_finalization
addaleax Aug 11, 2020
b933eef
doc: reduce repetitiveness on Consensus Seeking
mmarchini Aug 10, 2020
6ee2578
http2: add maxHeaderSize option to http2
preyunk May 29, 2020
15c9208
build: set --v8-enable-object-print by default
mmarchini Aug 10, 2020
8b56902
doc: edit (general) collaborator guide
Trott Aug 10, 2020
cb09606
doc: use sentence-casing for headers in collaborator guide
Trott Aug 10, 2020
8de6b72
benchmark: add benchmark script for resourceUsage
yashLadha Aug 9, 2020
698cae7
module: share CJS/ESM resolver fns, refactoring
guybedford Aug 9, 2020
8403118
policy: support conditions for redirects
bmeck Jul 17, 2020
aed8237
build: implement a Commit Queue in Actions
mmarchini Jun 29, 2020
9a79020
test: remove error message checking in test-worker-init-failure
Trott Aug 11, 2020
1a9496a
lib: add UNC support to url.pathToFileURL()
mceachen Aug 12, 2020
332e384
buffer: alias UInt ➡️ Uint in buffer methods
addaleax Aug 11, 2020
7ef5591
fs: guard against undefined behavior
ronag Aug 12, 2020
a78c638
test: use process.env.PYTHON to spawn python
addaleax Aug 9, 2020
69bcca1
crypto: avoid unitializing ECDH objects on error
tniessen Jul 10, 2020
3925fd6
doc: avoid _may_ in collaborator guide
Trott Aug 12, 2020
5009d82
test,doc: add missing uv_setup_args() calls
cjihrig Aug 12, 2020
d89a83c
build: move compiling for Windows ARM64 to Tier 2
joaocgreis Aug 11, 2020
2781f64
meta: add TSC as owner of governance-related docs
mmarchini Aug 11, 2020
e4a0e5b
module: fix check for package.json at volume root
DerekNonGeneric Aug 2, 2020
dbcb36d
errors: improve ERR_INVALID_OPT_VALUE error
lundibundi Aug 7, 2020
952f233
http: add RFC references for each status code
Voltra May 31, 2020
bdf26ae
build: add build flag for OSS-Fuzz integration
DavidKorczynski Aug 13, 2020
88919e5
test: allow ENFILE in test-worker-init-failure
Trott Aug 14, 2020
1c324d5
test: allow ENOENT in test-worker-init-failure
Trott Aug 14, 2020
c458e84
test: remove common.rootDir
Trott Aug 14, 2020
e54a684
doc: fix broken links in commit-queue.md
lpinca Aug 15, 2020
9ca4b2a
build: add CODEOWNERS linter action
mmarchini Aug 11, 2020
756c058
meta: fix codeowners docs path
mmarchini Aug 17, 2020
258f64f
doc: edit filehandle.close() entry in fs.md
Trott Aug 14, 2020
04defba
lib: allow to validate enums with validateOneOf
lundibundi Jun 26, 2020
03d6013
worker: do not crash when JSTransferable lists untransferable value
addaleax Aug 13, 2020
513ab0e
worker: fix --abort-on-uncaught-exception handling
addaleax Aug 11, 2020
7d0970c
doc,lib: remove unused error code
Trott Aug 15, 2020
e8eed5c
test: convert assertion that always fails to assert.fail()
Trott Aug 16, 2020
3bfe199
doc: remove "is recommended from crypto legacy API text
Trott Aug 9, 2020
47f2f45
doc: deprecate (doc-only) crypto.Certificate()
Trott Aug 16, 2020
7ed7ef7
test: move execution of WPT to worker threads
targos Aug 15, 2020
c080fc5
test: move test-inspector-already-activated-cli to parallel
Trott Aug 13, 2020
3360dcb
doc: fix some typos and grammar mistakes
HillaShx Aug 16, 2020
969fb1c
doc: improve async_hooks snippets
puzpuzpuz Aug 18, 2020
8f38c19
esm: improve error message of ERR_UNSUPPORTED_ESM_URL_SCHEME
lundibundi Aug 16, 2020
5c987ff
doc: fix file name to main.mjs and not main.js in esm.md
frank-dspeed Aug 15, 2020
b356b79
doc: reorder deprecated tls docs
jeromecovington Aug 9, 2020
7f0869f
build: run link checker in linter workflow
richardlau Aug 17, 2020
cdd4540
doc,tools: annotate broken links in actions workflow
richardlau Aug 17, 2020
34430ab
doc: move module core module doc to separate page
aduh95 Aug 7, 2020
6b45bf3
test: modernize test-cluster-master-error
addaleax Aug 8, 2020
90abdd3
net: validate custom lookup() output
cjihrig Aug 17, 2020
b73943e
workers: add support for data: URLs
aduh95 Jul 31, 2020
5214de7
doc: remove space above version picker
Vap0r1ze Aug 14, 2020
3133b75
doc: move addaleax to TSC emeritus
addaleax Aug 17, 2020
6048421
build,win: use x64 Node when building for ARM64
dennisameling Jun 22, 2020
a16f0f4
process: correctly parse Unicode in NODE_OPTIONS
bzoz Jul 22, 2020
9e0d18f
http2: use and support non-empty DATA frame with END_STREAM flag
clshortfuse Jun 14, 2020
2a78c33
test: run REPL preview test regardless of terminal type
Trott Aug 16, 2020
ef41ddf
doc: sort references lexically
Trott Aug 20, 2020
b1c3fb7
doc: fix bulleted list punctuation in BUILDING.md
Trott Aug 20, 2020
e16b3e7
test: fix test-cluster-net-listen-relative-path.js to run in /
Trott Aug 18, 2020
68b7a8d
deps: upgrade npm to 6.14.8
ruyadorno Aug 17, 2020
98f7d8e
n-api: handle weak no-finalizer refs correctly
Aug 19, 2020
e4679bd
doc: use 'console' info string for console output
Trott Aug 20, 2020
d6bb2ad
doc: adopt Microsoft Style Guide officially
Trott Aug 18, 2020
4b3b0e3
doc: fix ESM/CJS wrapper example
fox1t Aug 20, 2020
cc72584
http2: fix Http2Response.sendDate
joaolucasl Aug 20, 2020
e90cb49
tls: enable renegotiation when using BoringSSL
nornagon Aug 18, 2020
f2c2f42
doc: improve wording in deprecations.md
Trott Aug 21, 2020
bf7f492
doc: rename module pages
aduh95 Aug 7, 2020
7666d95
src: usage of modernize-use-equals-default
yashLadha Aug 17, 2020
fff1e7f
src: fix abort on uv_loop_init() failure
bnoordhuis Aug 22, 2020
dae93ca
doc: indicate the format of process.version
dguo Aug 22, 2020
9ebae0a
doc,n-api: add link to n-api tutorial website
jschlight Aug 21, 2020
ff15c92
doc: improve fs doc intro
jasnell Aug 19, 2020
cf34854
deps: upgrade to libuv 1.39.0
cjihrig Aug 25, 2020
a69d30e
module: drop `-u` alias for `--conditions`
richardlau Aug 26, 2020
cd32522
doc: add missing DEP ID for 'new crypto.Certificate()'
BethGriggs Aug 26, 2020
3153c2d
2020-08-27, Version 14.9.0 (Current)
Aug 20, 2020
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
Prev Previous commit
Next Next commit
doc: avoid _may_ in collaborator guide
Many style guides (including Microsoft's) suggest avoiding _may_ because
it can be unclear. Using _can_ or _might_ tends to increase clarity.

An example in this change:

> They may not change to a Runtime Deprecation until the next major
> release.

It's not clear if that means "They can not change until the next major
release" or "They might not change until the next major release but also
might change before then". Using _can_ or _might_ instead of _may_
clears up the ambiguity.

Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may

PR-URL: #34749
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
Trott authored and BethGriggs committed Aug 20, 2020
commit 3925fd65504ec0b16a21f9c0149d2ffdd7fd585f
64 changes: 32 additions & 32 deletions doc/guides/collaborator-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ as a _Contributor_. Ask if they have configured their git

### Closing issues and pull requests

Collaborators may close any issue or pull request that is not relevant to the
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
Expand Down Expand Up @@ -104,8 +104,8 @@ for the change.

Approval must be from Collaborators who are not authors of the change.

In some cases, it may be necessary to summon a GitHub team to a pull request for
review by @-mention.
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](#who-to-cc-in-the-issue-tracker).

If you are the first Collaborator to approve a pull request that has no CI yet,
Expand All @@ -114,7 +114,7 @@ pull request creator pushed new code since the last CI run.

### Consensus seeking

A pull request may land if it has the needed [approvals](#code-reviews),
A pull request can land if it has the needed [approvals](#code-reviews),
[CI](#testing-and-ci), [wait time](#waiting-for-approvals) and no
[outstanding objections](#objections). [Breaking changes](#breaking-changes)
must receive [TSC review](#involving-the-tsc) in addition to other
Expand All @@ -124,22 +124,22 @@ requirements. If a pull request meets all requirements except the

#### Objections

**Collaborators may object to a pull request by using the "Request
**Collaborators can object to a pull request by using the "Request
Changes" GitHub feature**. Dissent comments alone don't constitute an
objection. **Any PR 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**. Providing a set of
actionable steps alongside the objection is recommended.

If the objection is not clear to others, another collaborator may ask an
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, another collaborator may
days after a collaborator asks for clarification, another collaborator can
dismiss the objection**.

**Pull requests with outstanding objections must remain open until all
objections are satisfied**. If reaching consensus is not possible, a
collaborator may escalate the issue to the TSC by pinging `@nodejs/tsc` and
collaborator can escalate the issue to the TSC by pinging `@nodejs/tsc` and
adding the `tsc-agenda` label to the issue.

#### Helpful resources
Expand All @@ -151,27 +151,27 @@ adding the `tsc-agenda` label to the issue.
### Waiting for approvals

Before landing pull requests, allow 48 hours for input from other Collaborators.
Certain types of pull requests can be fast-tracked and may land after a shorter
Certain types of pull requests can be fast-tracked and can land after a shorter
delay. For example:

* Focused changes that affect only documentation and/or the test suite:
* `code-and-learn` tasks often fall into this category.
* `good-first-issue` pull requests may also be suitable.
* `good-first-issue` pull requests might also be suitable.
* Changes that fix regressions:
* Regressions that break the workflow (red CI or broken compilation).
* Regressions that happen right before a release, or reported soon after.

To propose fast-tracking a pull request, apply the `fast-track` label. Then add
a comment that Collaborators may upvote.
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 may be fast-tracked if two Collaborators approve the
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 may request fast-tracking of pull requests they did not author.
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.

Expand Down Expand Up @@ -298,7 +298,7 @@ For more information, see [Deprecations](#deprecations).

#### Breaking changes to internal elements

Breaking changes to internal elements may occur in semver-patch or semver-minor
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](https://github.com/nodejs/citgm) to test such changes.
Expand All @@ -308,14 +308,14 @@ providing a Public API in such cases.
#### Unintended breaking changes

Sometimes, a change intended to be non-breaking turns out to be a breaking
change. If such a change lands on the master branch, a Collaborator may revert
it. As an alternative to reverting, the TSC may apply the semver-major label
change. If such a change lands on the master branch, a Collaborator can revert
it. As an alternative to reverting, the TSC can apply the semver-major label
after-the-fact.

##### Reverting commits

Revert commits with `git revert <HASH>` or `git revert <FROM>..<TO>`. The
generated commit message will not have a subsystem and may violate line length
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.

Expand Down Expand Up @@ -355,7 +355,7 @@ documentation must state the deprecation status.
* There are no functional changes.
* By default, there will be no warnings emitted for such deprecations at
runtime.
* May cause a runtime warning with the [`--pending-deprecation`][] flag or
* Might cause a runtime warning with the [`--pending-deprecation`][] flag or
`NODE_PENDING_DEPRECATION` environment variable.

* Runtime Deprecation
Expand All @@ -364,15 +364,15 @@ documentation must state the deprecation status.

* End-of-Life
* The API is no longer subject to the semantic versioning rules.
* Backward-incompatible changes including complete removal of such APIs may
* Backward-incompatible changes including complete removal of such APIs can
occur at any time.

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 may make exceptions, deciding that one of
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
Expand All @@ -386,13 +386,13 @@ example, due to removal of an End-of-Life deprecated API).

<a id="deprecation-cycle"></a>
A _deprecation cycle_ is a major release during which an API has been in one of
the three Deprecation levels. Documentation-Only Deprecations may land in a
minor release. They may not change to a Runtime Deprecation until the next major
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 may remain in place for an unlimited
Documentation-Only and Runtime Deprecations can remain in place for an unlimited
duration.

Communicate pending deprecations and associated mitigations with the ecosystem
Expand All @@ -404,7 +404,7 @@ deprecation level of an API.

### Involving the TSC

Collaborators may opt to elevate pull requests or issues to the [TSC][].
Collaborators can opt to elevate pull requests or issues to the [TSC][].
Do this if a pull request or issue:

* Is labeled `semver-major`, or
Expand Down Expand Up @@ -469,7 +469,7 @@ code. If you wish to create the token yourself in advance, see

### Technical HOWTO

Clear any `am`/`rebase` that may already be underway:
Clear any `am`/`rebase` that might already be underway:

```text
$ git am --abort
Expand Down Expand Up @@ -586,7 +586,7 @@ for that commit. This is an opportunity to fix commit messages.
request. This makes it easy to trace a commit back to the conversation that
led up to that change.
* Optional: A `Fixes: X` line, where _X_ is the full GitHub URL for an
issue. A commit message may include more than one `Fixes:` lines.
issue. A commit message can include more than one `Fixes:` lines.
* Optional: One or more `Refs:` lines referencing a URL for any relevant
background.
* Required: A `Reviewed-By: Name <email>` line for each Collaborator who
Expand All @@ -595,7 +595,7 @@ for that commit. This is an opportunity to fix commit messages.
pull request.
* Protects against the assumption that GitHub will be around forever.

Other changes may have landed on master since the successful CI run. As a
Other changes might have landed on master 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
Expand Down Expand Up @@ -628,8 +628,8 @@ more than one commit.

### Troubleshooting

Sometimes, when running `git push upstream master`, you may get an error message
like this:
Sometimes, when running `git push upstream master`, you might get an error
message like this:

```console
To https://github.com/nodejs/node
Expand Down Expand Up @@ -683,7 +683,7 @@ corresponding staging branch (v10.x-staging, v8.x-staging, etc.).
Commits that land on master are cherry-picked to each staging branch as
appropriate. If a change applies only to the LTS branch, open the PR against the
*staging* branch. Commits from the staging branch land on the LTS branch only
when a release is being prepared. They may land on the LTS branch in a different
when a release is being prepared. They can land on the LTS branch in a different
order than they were in staging.

Only members of @nodejs/backporters should land commits onto LTS staging
Expand Down Expand Up @@ -711,7 +711,7 @@ 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
may impact an LTS release.
might impact an LTS release.

## Who to CC in the issue tracker

Expand Down Expand Up @@ -759,7 +759,7 @@ may impact an LTS release.
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>` may help.
If you cannot find who to cc for a file, `git shortlog -n -s <file>` can help.

["Merge Pull Request"]: https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-on-github
[Deprecation]: https://en.wikipedia.org/wiki/Deprecation
Expand Down