0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00
Commit Graph

152 Commits

Author SHA1 Message Date
Rich Trott
96fd0a0f4d doc: remove "note that" from pull-requests.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-06-23 07:07:24 -07:00
Rich Trott
c067fdbf44 doc: remove "note that" from maintaining-V8.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-06-23 07:07:23 -07:00
Rich Trott
73daba8649 doc: remove "note that" from maintaining-the-build-files.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-06-23 07:07:20 -07:00
Rich Trott
ebf5822f12 doc: remove "note that" from using-symbols.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-06-23 07:07:18 -07:00
Rich Trott
68cfa56d0c doc: remove "note that" from writing-and-running-benchmarks.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-06-23 07:07:17 -07:00
Rich Trott
ca276253fb doc: remove "note that" from writing-tests.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16

PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-06-23 07:07:15 -07:00
rexagod
558f8349c3 doc: clarify commit message format in pull-requests.md
Resolved ambiguous meanings for the term `body of commit message`
in `pull-requests.md` file,

Fixes: https://github.com/nodejs/node/issues/28068
PR-URL: https://github.com/nodejs/node/pull/28125
Reviewed-By: Rich Trott <rtrott@gmail.com>
2019-06-16 16:51:42 -07:00
rexagod
03d008fe28 doc: fix prohibited-strings warning in pull-requests.md
Correct "Github" to "GitHub" in compliance
to the linting standards.

PR-URL: https://github.com/nodejs/node/pull/28127
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-06-09 20:15:25 -07:00
Tariq Ramlall
18be28892f doc: adds link to nightly code coverage report
Adds a link to the nightly test code coverage report page
to the writing-tests.md documentation.

PR-URL: https://github.com/nodejs/node/pull/27922
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-30 08:37:51 +02:00
Aymen Naghmouchi
7938238b31
doc: add internal documentation
This adds documentation that is meant as internal only. As first entry
the `--inspect-brk-node` flag got documented here.

PR-URL: https://github.com/nodejs/node/pull/26665
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-04-15 18:58:52 +02:00
Myles Borins
21b739fb69
doc: add missing step to npm release process
PR-URL: https://github.com/nodejs/node/pull/27105
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-04-06 20:57:30 -04:00
gengjiawen
0b57175813 doc: change links to https in benchmark guide
PR-URL: https://github.com/nodejs/node/pull/26925
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2019-03-29 06:26:23 +01:00
Vse Mozhet Byt
4e9dc31817 doc: fix nits in writing-tests.md
* Correct a typo.
* Normalize spaces.
* Split a paragraph with different topics.

PR-URL: https://github.com/nodejs/node/pull/26543
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-03-09 14:17:16 +02:00
Sam Roberts
4d89fcc6d6 doc: add guidance on console output in tests
PR-URL: https://github.com/nodejs/node/pull/26456
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-03-08 09:44:57 -08:00
Thang Tran
1c66ad408b
doc: renamed remote's name
To keep consistency through-out the guide.

Fixes: https://github.com/nodejs/node/issues/26045

PR-URL: https://github.com/nodejs/node/pull/26050
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Masashi Hirano <shisama07@gmail.com>
2019-02-13 23:57:38 +01:00
Lance Ball
93a57c3f1f doc: add a sentence about REPLACEME in code changes
When adding to the REPL API recently, I was unsure what to put as a
version number for the new method I added. This change adds a reference
to `releases.md` where the use of `REPLACEME` is discussed.

PR-URL: https://github.com/nodejs/node/pull/25961
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-02-07 05:26:04 +01:00
Kazushi Kitaya
9b7226d66c
doc: update benchmark doc
Benchmark for arrays no longer exists, but it was still referenced in
documentation.

Refs: https://github.com/nodejs/node/pull/21831

PR-URL: https://github.com/nodejs/node/pull/25367
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2019-01-09 01:39:43 +01:00
Sam Roberts
845fdd02f4
doc: describe root cert update process
PR-URL: https://github.com/nodejs/node/pull/25113
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-12-21 15:54:44 +01:00
Ruben Bridgewater
50dd555910
doc,lib,test: capitalize comment sentences
This activates the eslint capitalize comment rule for comments
above 50 characters.

PR-URL: https://github.com/nodejs/node/pull/24996
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-12-17 17:14:35 +01:00
Daijiro Wachi
450ab14d4b doc: update a link of npm repository
PR-URL: https://github.com/nodejs/node/pull/24969
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-12-13 17:23:56 -08:00
ka2jun8
9fe02af794 doc: replace anonymous function with arrow function
PR-URL: https://github.com/nodejs/node/pull/24617
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-11-24 12:57:30 +02:00
yuriettys
6e4502c635 doc: replace anonymous function with arrow function
PR-URL: https://github.com/nodejs/node/pull/24627
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ouyang Yadong <oyydoibh@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-11-24 11:33:37 +02:00
Vse Mozhet Byt
9c7b87b9a1 doc,meta: update PR approving info
Refs: https://github.com/nodejs/node/pull/22255

PR-URL: https://github.com/nodejs/node/pull/24561
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
2018-11-21 20:01:27 -08:00
Daijiro Wachi
7067572a63 doc: update core-validate-commit url
PR-URL: https://github.com/nodejs/node/pull/24331
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2018-11-13 09:15:18 +01:00
Joyee Cheung
22f3ff9617
doc: remove legacy WPT integration guide
Point to the new guide in test/wpt/README.md instead.

PR-URL: https://github.com/nodejs/node/pull/24035
Refs: https://github.com/nodejs/node/issues/23192
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
2018-11-09 20:27:21 +08:00
Rich Trott
7e1b178fb6 doc: streamline CONTRIBUTING.md
PR-URL: https://github.com/nodejs/node/pull/24010
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
2018-11-05 05:59:49 +01:00
mritunjaygoutam12
c8757f8c4f doc: correct link to test coverage command
PR-URL: https://github.com/nodejs/node/pull/24049
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-11-04 12:17:03 +02:00
Rich Trott
03f52524e4 doc: use Node.js instead of Node
Per branding guidelines from the Foundation, use Node.js and not Node.

PR-URL: https://github.com/nodejs/node/pull/23967
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-10-31 23:26:51 -07:00
Kamat, Trivikram
8c244ddd98 doc: moved test instructions to BUILDING.md
Fixes: https://github.com/nodejs/node/issues/23491

Duplicate test instructions were present in pull-requests.md
Merged the instructions in BUILDING.md and provided a link from
pull-requests.md

PR-URL: https://github.com/nodejs/node/pull/23949
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
2018-10-30 23:00:49 -07:00
Denys Otrishko
f90cf19fdd
doc: remove notice of dashes in V8 options
Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

PR-URL: https://github.com/nodejs/node/pull/23903
Refs: https://github.com/nodejs/node/pull/18592
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
2018-10-29 21:24:08 +00:00
Ali Ijaz Sheikh
72cf81f514 doc: add Backport-PR-URL info in backport guide
PR-URL: https://github.com/nodejs/node/pull/23701
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-10-19 09:00:08 -07:00
Rich Trott
b155358235 doc: remove 72-hour mentions in pull-requests.md
vsemozhetbyt noted that there were two mentions of the now-defunct
72-hour-rule in pull-requests.md. This change updates the text to
reflect current wait-time rules.

PR-URL: https://github.com/nodejs/node/pull/23309
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-10-07 16:44:43 -07:00
Gabriel Schulhof
fd6a7d4db1 doc: remove ABI guide
Move it to the nodejs.org repo.

PR-URL: https://github.com/nodejs/node/pull/23303
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-10-07 12:03:38 -04:00
Gabriel Schulhof
65366addb2 doc: add guide about abi stability
Re: https://github.com/nodejs/abi-stable-node/issues/332#issuecomment-418379903
PR-URL: https://github.com/nodejs/node/pull/23229
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-10-06 04:55:09 -04:00
Justin Lee
250957b61e doc: fix incorrect anchoring (#vcbuild.bat -> #vcbuildbat)
PR-URL: https://github.com/nodejs/node/pull/23211
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-10-02 09:07:44 +03:00
Justin Lee
9b00c84e9d doc: fix minor typo (to early -> too early)
PR-URL: https://github.com/nodejs/node/pull/23211
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-10-02 09:06:51 +03:00
Matheus Marchini
fa14503602
doc: move perf tools and APIs to Tier 3
V8 CodeEventHandler, V8 CpuProfiler, Linux perf and the
`--interpreted-frames-native-stack`, `--prof` and `--prof-process` flags
satisfies our Diagnostics Support requirements for Tier 3. V8
CodeEventHandler and CpuProfiler are tested as part of our V8 CI, and
`Linux perf` / `--interpreted-frames-native-stack` are tested by
`test/v8-updates/test-linux-perf.js`. `--prof` and `--prof-process` are
tested in Node.js test suite.

PR-URL: https://github.com/nodejs/node/pull/22915
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2018-10-01 13:07:28 -03:00
Michaël Zasso
408e8ce22c doc: update maintaining V8 guide
Replace references to the outdated `update-v8` tool to its replacement
in `node-core-utils`

PR-URL: https://github.com/nodejs/node/pull/22913
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2018-09-21 05:46:51 +02:00
Kamat, Trivikram
ab35194cb0
doc: update 6.x to 8.x in backporting wiki
PR-URL: https://github.com/nodejs/node/pull/22879
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-09-17 17:51:20 +02:00
Matteo Collina
4f5aa3607d doc: added symbols guidelines
PR-URL: https://github.com/nodejs/node/pull/22684
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
2018-09-07 09:23:03 +02:00
Denys Otrishko
7aac70607d
benchmark: add lines to scatter plots
Adds lines between the points of the same category in scatter.R plots.

PR-URL: https://github.com/nodejs/node/pull/22074
Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
2018-09-02 13:15:41 +02:00
Matheus Marchini
21e8ce2297
doc: add profiling APIs to the diagnostics support document
Add V8 CodeEventHandler and --interpreted-frames-native-stack to our
diagnostics tiers of support document as Unclassified APIs.

PR-URL: https://github.com/nodejs/node/pull/22588
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-08-31 18:56:12 +02:00
Matheus Marchini
de67ae6cdf
doc: update Linux perf test status in our CI
We have tests for Linux perf under `test/v8-updates/test-linux-perf.js`,
and those tests are run as part of the `node-test-commit-v8-linux` job.

PR-URL: https://github.com/nodejs/node/pull/22588
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-08-31 18:56:11 +02:00
Michael Dawson
c241f4ac4a doc: initial cut at support tiers for diag tools
PR-URL: https://github.com/nodejs/node/pull/21870
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Matheus Marchini <matheus@sthima.com>
2018-08-27 20:40:57 -04:00
Anna Henningsen
99b1ada331
doc: clarify git config name/email requirements
The previous wording sounded like this was a necessary for
contributing. This clarifies that it is not, and tells people what
we do use their info for.

PR-URL: https://github.com/nodejs/node/pull/22433
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
2018-08-26 14:02:08 +01:00
Rich Trott
fcb46a4626 doc: replace _WG_ with _team_
AFAICT, there is no N-API Working Group. There *is* an N-API team, but
AFAIK there is no charter etc. (And if I'm wrong and there is, then
https://nodejs.org/en/about/working-groups/ needs an update!)

PR-URL: https://github.com/nodejs/node/pull/22183
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-08-08 16:20:30 -07:00
Hitesh Kanwathirtha
e83126a883 doc: add guide for updating N-API API surface
This adds a new guide that outlines the principles and guidelines
for contributing a new API to the N-API surface. These guidelines
were formulated based on discussions in the API working group.

PR-URL: https://github.com/nodejs/node/pull/21877
Refs: https://github.com/nodejs/abi-stable-node/issues/301
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-07-25 23:43:38 +03:00
Michaël Zasso
df08779e0d
test: make crashOnUnhandleRejection opt-out
This commit removes `common.crashOnUnhandledRejection()` and adds
`common.disableCrashOnUnhandledRejection()`.

To reduce the risk of mistakes and make writing tests that involve
promises simpler, always install the unhandledRejection hook in tests
and provide a way to disable it for the rare cases where it's needed.

PR-URL: https://github.com/nodejs/node/pull/21849
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-07-19 08:47:28 +02:00
Myles Borins
7570ad58e9
doc: add policy for landing new npm releases
This change in policy sets clear terms for when / how npm releases
can be landed into master and how long they are expected to bake in the
ecosystem. This is to cover all release types of npm including semver-major
releases.

What Node.js releases the updates land into are at the discretion of the
release team.

PR-URL: https://github.com/nodejs/node/pull/21594
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
2018-07-13 16:06:30 -04:00
Daniel Bevenius
b56f65e28c doc: add example of using filter with cctest
This commit adds examples of specifying filters when running cctest.
This can be useful when debugging and limiting the test cases run to
the test cases of interest and I think worth documenting.

PR-URL: https://github.com/nodejs/node/pull/21401
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2018-06-21 13:30:40 +02:00