2
2
3
3
## Contents
4
4
5
- * [ Issues and Pull Requests ] ( #issues-and-pull-requests )
6
- * [ Welcoming First-Time Contributors ] ( #welcoming-first-time-contributors )
7
- * [ Closing Issues and Pull Requests ] ( #closing-issues-and-pull-requests )
5
+ * [ Issues and pull requests ] ( #issues-and-pull-requests )
6
+ * [ Welcoming first-time contributors ] ( #welcoming-first-time-contributors )
7
+ * [ Closing issues and pull requests ] ( #closing-issues-and-pull-requests )
8
8
* [ Author ready pull requests] ( #author-ready-pull-requests )
9
9
* [ Handling own pull requests] ( #handling-own-pull-requests )
10
- * [ Accepting Modifications ] ( #accepting-modifications )
11
- * [ Code Reviews ] ( #code-reviews )
12
- * [ Consensus Seeking ] ( #consensus-seeking )
13
- * [ Waiting for Approvals ] ( #waiting-for-approvals )
10
+ * [ Accepting modifications ] ( #accepting-modifications )
11
+ * [ Code reviews ] ( #code-reviews )
12
+ * [ Consensus seeking ] ( #consensus-seeking )
13
+ * [ Waiting for approvals ] ( #waiting-for-approvals )
14
14
* [ Testing and CI] ( #testing-and-ci )
15
- * [ Useful CI Jobs ] ( #useful-ci-jobs )
16
- * [ Starting a CI Job ] ( #starting-a-ci-job )
17
- * [ Internal vs. Public API] ( #internal-vs-public-api )
18
- * [ Breaking Changes ] ( #breaking-changes )
19
- * [ Breaking Changes and Deprecations ] ( #breaking-changes-and-deprecations )
20
- * [ Breaking Changes to Internal Elements ] ( #breaking-changes-to-internal-elements )
21
- * [ Unintended Breaking Changes ] ( #unintended-breaking-changes )
15
+ * [ Useful CI jobs ] ( #useful-ci-jobs )
16
+ * [ Starting a CI job ] ( #starting-a-ci-job )
17
+ * [ Internal vs. public API] ( #internal-vs-public-api )
18
+ * [ Breaking changes ] ( #breaking-changes )
19
+ * [ Breaking changes and deprecations ] ( #breaking-changes-and-deprecations )
20
+ * [ Breaking changes to internal elements ] ( #breaking-changes-to-internal-elements )
21
+ * [ Unintended breaking changes ] ( #unintended-breaking-changes )
22
22
* [ Reverting commits] ( #reverting-commits )
23
- * [ Introducing New Modules ] ( #introducing-new-modules )
23
+ * [ Introducing new modules ] ( #introducing-new-modules )
24
24
* [ Additions to N-API] ( #additions-to-n-api )
25
25
* [ Deprecations] ( #deprecations )
26
26
* [ Involving the TSC] ( #involving-the-tsc )
27
- * [ Landing Pull Requests ] ( #landing-pull-requests )
27
+ * [ Landing pull requests ] ( #landing-pull-requests )
28
28
* [ Using ` git-node ` ] ( #using-git-node )
29
29
* [ Technical HOWTO] ( #technical-howto )
30
30
* [ Troubleshooting] ( #troubleshooting )
31
- * [ I Made a Mistake ] ( #i-made-a-mistake )
32
- * [ Long Term Support ] ( #long-term-support )
31
+ * [ I made a mistake ] ( #i-made-a-mistake )
32
+ * [ Long term support ] ( #long-term-support )
33
33
* [ What is LTS?] ( #what-is-lts )
34
- * [ How are LTS Branches Managed ?] ( #how-are-lts-branches-managed )
34
+ * [ How are LTS branches managed ?] ( #how-are-lts-branches-managed )
35
35
* [ How can I help?] ( #how-can-i-help )
36
36
* [ Who to CC in the issue tracker] ( #who-to-cc-in-the-issue-tracker )
37
37
@@ -40,13 +40,13 @@ Collaborators should understand the
40
40
[ guidelines for new contributors] ( ../../CONTRIBUTING.md ) and the
41
41
[ project governance model] ( ../../GOVERNANCE.md ) .
42
42
43
- ## Issues and Pull Requests
43
+ ## Issues and pull requests
44
44
45
45
Mind these guidelines, the opinions of other Collaborators, and guidance of the
46
46
[ TSC] [ ] . Notify other qualified parties for more input on an issue or a pull
47
47
request. See [ Who to CC in the issue tracker] ( #who-to-cc-in-the-issue-tracker ) .
48
48
49
- ### Welcoming First-Time Contributors
49
+ ### Welcoming first-time contributors
50
50
51
51
Always show courtesy to individuals submitting issues and pull requests. Be
52
52
welcoming to first-time contributors, identified by the GitHub
@@ -57,7 +57,7 @@ request author. This way, once their pull request lands, GitHub will show them
57
57
as a _ Contributor_ . Ask if they have configured their git
58
58
[ username] [ git-username ] and [ email] [ git-email ] to their liking.
59
59
60
- ### Closing Issues and Pull Requests
60
+ ### Closing issues and pull requests
61
61
62
62
Collaborators may close any issue or pull request that is not relevant to the
63
63
future of the Node.js project. Where this is unclear, leave the issue or pull
@@ -87,13 +87,13 @@ to land but is [author ready](#author-ready-pull-requests), add the
87
87
` author ready ` label. If you wish to land the pull request yourself, use the
88
88
"assign yourself" link to self-assign it.
89
89
90
- ## Accepting Modifications
90
+ ## Accepting modifications
91
91
92
92
Contributors propose modifications to Node.js using GitHub pull requests. This
93
93
includes modifications proposed by TSC members and other Collaborators. A pull
94
94
request must pass code review and CI before landing into the codebase.
95
95
96
- ### Code Reviews
96
+ ### Code reviews
97
97
98
98
At least two Collaborators must approve a pull request before the pull request
99
99
lands. One Collaborator approval is enough if the pull request has been open
@@ -112,7 +112,7 @@ If you are the first Collaborator to approve a pull request that has no CI yet,
112
112
please [ start one] ( #testing-and-ci ) . Please also start a new CI if the
113
113
pull request creator pushed new code since the last CI run.
114
114
115
- ### Consensus Seeking
115
+ ### Consensus seeking
116
116
117
117
A pull request may land if it has the needed [ approvals] ( #code-reviews ) ,
118
118
[ CI] ( #testing-and-ci ) , [ wait time] ( #waiting-for-approvals ) and no
@@ -148,7 +148,7 @@ adding the `tsc-agenda` label to the issue.
148
148
* [ How to Do Code Reviews Like a Human (Part Two)] ( https://mtlynch.io/human-code-reviews-2/ )
149
149
* [ Code Review Etiquette] ( https://css-tricks.com/code-review-etiquette/ )
150
150
151
- ### Waiting for Approvals
151
+ ### Waiting for approvals
152
152
153
153
Before landing pull requests, allow 48 hours for input from other Collaborators.
154
154
Certain types of pull requests can be fast-tracked and may land after a shorter
@@ -194,7 +194,7 @@ everything else. Start a fresh CI if more than seven days have elapsed since
194
194
the original failing CI as the compiled binaries for the Windows and ARM
195
195
platforms are only kept for seven days.
196
196
197
- #### Useful CI Jobs
197
+ #### Useful CI jobs
198
198
199
199
* [ ` node-test-pull-request ` ] ( https://ci.nodejs.org/job/node-test-pull-request/ )
200
200
is the CI job to test pull requests. It runs the ` build-ci ` and ` test-ci `
@@ -219,7 +219,7 @@ not used in other CI test runs (such as tests in the `internet` or `pummel`
219
219
directories). It can also make sure tests pass when provided with a flag not
220
220
used in other CI test runs (such as ` --worker ` ).
221
221
222
- #### Starting a CI Job
222
+ #### Starting a CI job
223
223
224
224
From the CI Job page, click "Build with Parameters" on the left side.
225
225
@@ -244,7 +244,7 @@ Copy/paste the URL for the job into a comment in the pull request.
244
244
[ ` node-test-pull-request ` ] ( https://ci.nodejs.org/job/node-test-pull-request/ )
245
245
is an exception where the GitHub bot will automatically post for you.
246
246
247
- ### Internal vs. Public API
247
+ ### Internal vs. public API
248
248
249
249
All functionality in the official Node.js documentation is part of the public
250
250
API. Any undocumented object, property, method, argument, behavior, or event is
@@ -269,7 +269,7 @@ public. In those cases, the TSC makes a determination.
269
269
270
270
For undocumented APIs that are public, open a pull request documenting the API.
271
271
272
- ### Breaking Changes
272
+ ### Breaking changes
273
273
274
274
At least two TSC members must approve backward-incompatible changes to the
275
275
master branch.
@@ -283,7 +283,7 @@ Examples of breaking changes include:
283
283
* Altering expected timing of an event.
284
284
* Changing the side effects of using a particular API.
285
285
286
- #### Breaking Changes and Deprecations
286
+ #### Breaking changes and deprecations
287
287
288
288
Existing stable public APIs that change in a backward-incompatible way must
289
289
undergo deprecation. The exceptions to this rule are:
@@ -296,7 +296,7 @@ undergo deprecation. The exceptions to this rule are:
296
296
297
297
For more information, see [ Deprecations] ( #deprecations ) .
298
298
299
- #### Breaking Changes to Internal Elements
299
+ #### Breaking changes to internal elements
300
300
301
301
Breaking changes to internal elements may occur in semver-patch or semver-minor
302
302
commits. Take significant care when making and reviewing such changes. Make
@@ -305,7 +305,7 @@ an effort to determine the potential impact of the change in the ecosystem. Use
305
305
If a change will cause ecosystem breakage, then it is semver-major. Consider
306
306
providing a Public API in such cases.
307
307
308
- #### Unintended Breaking Changes
308
+ #### Unintended breaking changes
309
309
310
310
Sometimes, a change intended to be non-breaking turns out to be a breaking
311
311
change. If such a change lands on the master branch, a Collaborator may revert
@@ -319,7 +319,7 @@ generated commit message will not have a subsystem and may violate line length
319
319
rules. That is OK. Append the reason for the revert and any ` Refs ` or ` Fixes `
320
320
metadata. Raise a pull request like any other change.
321
321
322
- ### Introducing New Modules
322
+ ### Introducing new modules
323
323
324
324
Treat commits that introduce new core modules with extra care.
325
325
@@ -418,7 +418,7 @@ Do this if a pull request or issue:
418
418
419
419
The TSC serves as the final arbiter where required.
420
420
421
- ## Landing Pull Requests
421
+ ## Landing pull requests
422
422
423
423
1 . Avoid landing pull requests that have someone else as an assignee. Authors
424
424
who wish to land their own pull requests will self-assign them. Sometimes, an
@@ -651,7 +651,7 @@ make -j4 test
651
651
git push upstream master
652
652
```
653
653
654
- ### I Made a Mistake
654
+ ### I made a mistake
655
655
656
656
* Ping a TSC member.
657
657
* ` #node-dev ` on freenode.
@@ -665,7 +665,7 @@ git push upstream master
665
665
change.
666
666
* Post to ` #node-dev ` (IRC) if you force push.
667
667
668
- ### Long Term Support
668
+ ### Long term support
669
669
670
670
#### What is LTS?
671
671
@@ -675,7 +675,7 @@ versions. You can find more information
675
675
a branch enters LTS, the release plan limits the types of changes permitted in
676
676
the branch.
677
677
678
- #### How are LTS Branches Managed ?
678
+ #### How are LTS branches managed ?
679
679
680
680
Each LTS release has a corresponding branch (v10.x, v8.x, etc.). Each also has a
681
681
corresponding staging branch (v10.x-staging, v8.x-staging, etc.).
0 commit comments