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: use sentence-casing for headers in collaborator guide
The collaborator guide uses both sentence case and headline case for
headings. Use sentence case to conform with our style guide.

PR-URL: #34713
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
Trott authored and BethGriggs committed Aug 20, 2020
commit cb0960635bbdafba167160763341303ce7204b2a
76 changes: 38 additions & 38 deletions doc/guides/collaborator-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,36 @@

## Contents

* [Issues and Pull Requests](#issues-and-pull-requests)
* [Welcoming First-Time Contributors](#welcoming-first-time-contributors)
* [Closing Issues and Pull Requests](#closing-issues-and-pull-requests)
* [Issues and pull requests](#issues-and-pull-requests)
* [Welcoming first-time contributors](#welcoming-first-time-contributors)
* [Closing issues and pull requests](#closing-issues-and-pull-requests)
* [Author ready pull requests](#author-ready-pull-requests)
* [Handling own pull requests](#handling-own-pull-requests)
* [Accepting Modifications](#accepting-modifications)
* [Code Reviews](#code-reviews)
* [Consensus Seeking](#consensus-seeking)
* [Waiting for Approvals](#waiting-for-approvals)
* [Accepting modifications](#accepting-modifications)
* [Code reviews](#code-reviews)
* [Consensus seeking](#consensus-seeking)
* [Waiting for approvals](#waiting-for-approvals)
* [Testing and CI](#testing-and-ci)
* [Useful CI Jobs](#useful-ci-jobs)
* [Starting a CI Job](#starting-a-ci-job)
* [Internal vs. Public API](#internal-vs-public-api)
* [Breaking Changes](#breaking-changes)
* [Breaking Changes and Deprecations](#breaking-changes-and-deprecations)
* [Breaking Changes to Internal Elements](#breaking-changes-to-internal-elements)
* [Unintended Breaking Changes](#unintended-breaking-changes)
* [Useful CI jobs](#useful-ci-jobs)
* [Starting a CI job](#starting-a-ci-job)
* [Internal vs. public API](#internal-vs-public-api)
* [Breaking changes](#breaking-changes)
* [Breaking changes and deprecations](#breaking-changes-and-deprecations)
* [Breaking changes to internal elements](#breaking-changes-to-internal-elements)
* [Unintended breaking changes](#unintended-breaking-changes)
* [Reverting commits](#reverting-commits)
* [Introducing New Modules](#introducing-new-modules)
* [Introducing new modules](#introducing-new-modules)
* [Additions to N-API](#additions-to-n-api)
* [Deprecations](#deprecations)
* [Involving the TSC](#involving-the-tsc)
* [Landing Pull Requests](#landing-pull-requests)
* [Landing pull requests](#landing-pull-requests)
* [Using `git-node`](#using-git-node)
* [Technical HOWTO](#technical-howto)
* [Troubleshooting](#troubleshooting)
* [I Made a Mistake](#i-made-a-mistake)
* [Long Term Support](#long-term-support)
* [I made a mistake](#i-made-a-mistake)
* [Long term support](#long-term-support)
* [What is LTS?](#what-is-lts)
* [How are LTS Branches Managed?](#how-are-lts-branches-managed)
* [How are LTS branches managed?](#how-are-lts-branches-managed)
* [How can I help?](#how-can-i-help)
* [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker)

Expand All @@ -40,13 +40,13 @@ Collaborators should understand the
[guidelines for new contributors](../../CONTRIBUTING.md) and the
[project governance model](../../GOVERNANCE.md).

## Issues and Pull Requests
## Issues and pull requests

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](#who-to-cc-in-the-issue-tracker).

### Welcoming First-Time Contributors
### Welcoming first-time contributors

Always show courtesy to individuals submitting issues and pull requests. Be
welcoming to first-time contributors, identified by the GitHub
Expand All @@ -57,7 +57,7 @@ request author. This way, once their pull request lands, GitHub will show them
as a _Contributor_. Ask if they have configured their git
[username][git-username] and [email][git-email] to their liking.

### Closing Issues and Pull Requests
### Closing issues and pull requests

Collaborators may 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
Expand Down Expand Up @@ -87,13 +87,13 @@ to land but is [author ready](#author-ready-pull-requests), add the
`author ready` label. If you wish to land the pull request yourself, use the
"assign yourself" link to self-assign it.

## Accepting Modifications
## Accepting modifications

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.

### Code Reviews
### Code reviews

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
Expand All @@ -112,7 +112,7 @@ If you are the first Collaborator to approve a pull request that has no CI yet,
please [start one](#testing-and-ci). Please also start a new CI if the
pull request creator pushed new code since the last CI run.

### Consensus Seeking
### Consensus seeking

A pull request may land if it has the needed [approvals](#code-reviews),
[CI](#testing-and-ci), [wait time](#waiting-for-approvals) and no
Expand Down Expand Up @@ -148,7 +148,7 @@ adding the `tsc-agenda` label to the issue.
* [How to Do Code Reviews Like a Human (Part Two)](https://mtlynch.io/human-code-reviews-2/)
* [Code Review Etiquette](https://css-tricks.com/code-review-etiquette/)

### Waiting for Approvals
### 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
Expand Down Expand Up @@ -194,7 +194,7 @@ 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.

#### Useful CI Jobs
#### Useful CI jobs

* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
is the CI job to test pull requests. It runs the `build-ci` and `test-ci`
Expand All @@ -219,7 +219,7 @@ 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`).

#### Starting a CI Job
#### Starting a CI job

From the CI Job page, click "Build with Parameters" on the left side.

Expand All @@ -244,7 +244,7 @@ Copy/paste the URL for the job into a comment in the pull request.
[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
is an exception where the GitHub bot will automatically post for you.

### Internal vs. Public API
### Internal vs. public API

All functionality in the official Node.js documentation is part of the public
API. Any undocumented object, property, method, argument, behavior, or event is
Expand All @@ -269,7 +269,7 @@ public. In those cases, the TSC makes a determination.

For undocumented APIs that are public, open a pull request documenting the API.

### Breaking Changes
### Breaking changes

At least two TSC members must approve backward-incompatible changes to the
master branch.
Expand All @@ -283,7 +283,7 @@ Examples of breaking changes include:
* Altering expected timing of an event.
* Changing the side effects of using a particular API.

#### Breaking Changes and Deprecations
#### Breaking changes and deprecations

Existing stable public APIs that change in a backward-incompatible way must
undergo deprecation. The exceptions to this rule are:
Expand All @@ -296,7 +296,7 @@ undergo deprecation. The exceptions to this rule are:

For more information, see [Deprecations](#deprecations).

#### Breaking Changes to Internal Elements
#### Breaking changes to internal elements

Breaking changes to internal elements may occur in semver-patch or semver-minor
commits. Take significant care when making and reviewing such changes. Make
Expand All @@ -305,7 +305,7 @@ an effort to determine the potential impact of the change in the ecosystem. Use
If a change will cause ecosystem breakage, then it is semver-major. Consider
providing a Public API in such cases.

#### Unintended Breaking Changes
#### 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
Expand All @@ -319,7 +319,7 @@ generated commit message will not have a subsystem and may 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.

### Introducing New Modules
### Introducing new modules

Treat commits that introduce new core modules with extra care.

Expand Down Expand Up @@ -418,7 +418,7 @@ Do this if a pull request or issue:

The TSC serves as the final arbiter where required.

## Landing Pull Requests
## Landing pull requests

1. Avoid landing pull requests that have someone else as an assignee. Authors
who wish to land their own pull requests will self-assign them. Sometimes, an
Expand Down Expand Up @@ -651,7 +651,7 @@ make -j4 test
git push upstream master
```

### I Made a Mistake
### I made a mistake

* Ping a TSC member.
* `#node-dev` on freenode.
Expand All @@ -665,7 +665,7 @@ git push upstream master
change.
* Post to `#node-dev` (IRC) if you force push.

### Long Term Support
### Long term support

#### What is LTS?

Expand All @@ -675,7 +675,7 @@ versions. You can find more information
a branch enters LTS, the release plan limits the types of changes permitted in
the branch.

#### How are LTS Branches Managed?
#### How are LTS branches managed?

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.).
Expand Down