v6.11.2 proposal

.eslintignore

@@ -7,3 +7,4 @@ test/tmp*/
 tools/eslint
 node_modules
 benchmark/tmp/
+doc/**/*.js

.eslintrc.yaml

@@ -1,5 +1,8 @@
 root: true
 
+plugins:
+  - markdown
+
 env:
   node: true
   es6: true
@@ -38,7 +41,7 @@ rules:
   dot-location: [2, property]
   no-fallthrough: 2
   no-global-assign: 2
-  no-multi-spaces: 2
+  no-multi-spaces: [2, {ignoreEOLComments: true}]
   no-octal: 2
   no-redeclare: 2
   no-self-assign: 2
@@ -92,15 +95,26 @@ rules:
   eol-last: 2
   func-call-spacing: 2
   func-name-matching: 2
-  indent: [2, 2, {ArrayExpression: first,
-                  CallExpression: {arguments: first},
-                  MemberExpression: 1,
-                  ObjectExpression: first,
-                  SwitchCase: 1}]
+  func-style: [2, declaration, {allowArrowFunctions: true}]
+  # indent: [2, 2, {ArrayExpression: first,
+  #                 CallExpression: {arguments: first},
+  #                 FunctionDeclaration: {parameters: first},
+  #                 FunctionExpression: {parameters: first},
+  #                 MemberExpression: off,
+  #                 ObjectExpression: first,
+  #                 SwitchCase: 1}]
+  indent-legacy: [2, 2, {ArrayExpression: first,
+                         CallExpression: {arguments: first},
+                         MemberExpression: 1,
+                         ObjectExpression: first,
+                         SwitchCase: 1}]
   key-spacing: [2, {mode: minimum}]
   keyword-spacing: 2
   linebreak-style: [2, unix]
-  max-len: [2, {code: 80, ignoreUrls: true, tabWidth: 2}]
+  max-len: [2, {code: 80,
+                ignoreRegExpLiterals: true,
+                ignoreUrls: true,
+                tabWidth: 2}]
   new-parens: 2
   no-mixed-spaces-and-tabs: 2
   no-multiple-empty-lines: [2, {max: 2, maxEOF: 0, maxBOF: 0}]
@@ -109,7 +123,13 @@ rules:
     message: "setTimeout() must be invoked with at least two arguments."
   }, {
     selector: "CallExpression[callee.name='setInterval'][arguments.length<2]",
-    message: "setInterval() must be invoked with at least 2 arguments"
+    message: "setInterval() must be invoked with at least 2 arguments."
+  }, {
+    selector: "ThrowStatement > CallExpression[callee.name=/Error$/]",
+    message: "Use new keyword when throwing an Error."
+  }, {
+    selector: "CallExpression[callee.object.name='assert'][callee.property.name='fail'][arguments.length=1]",
+    message: "assert.fail() message should be third argument"
   }]
   no-tabs: 2
   no-trailing-spaces: 2
@@ -118,7 +138,11 @@ rules:
   semi: 2
   semi-spacing: 2
   space-before-blocks: [2, always]
-  space-before-function-paren: [2, never]
+  space-before-function-paren: [2, {
+    "anonymous": "never",
+    "named": "never",
+    "asyncArrow": "always"
+  }]
   space-in-parens: [2, never]
   space-infix-ops: 2
   space-unary-ops: 2
@@ -140,10 +164,7 @@ rules:
 
   # Custom rules in tools/eslint-rules
   align-multiline-assignment: 2
-  assert-fail-single-argument: 2
-  assert-throws-arguments: [2, { requireTwo: false }]
-  new-with-error: [2, Error, RangeError, TypeError, SyntaxError, ReferenceError]
-  no-useless-regex-char-class-escape: [2, { override: ['[', ']'] }]
+  assert-throws-arguments: [2, { requireTwo: true }]
 
 # Global scoped method and vars
 globals:

.gitignore

@@ -34,6 +34,7 @@ node_g
 .benchmark_reports
 icu_config.gypi
 .eslintcache
+node_trace.*.log
 
 /out
 
@@ -59,6 +60,8 @@ ipch/
 *.VC.opendb
 .vs/
 .vscode/
+/deps/v8/src/debug/obj
+/*.exe
 
 /config.mk
 /config.gypi

BUILDING.md

@@ -26,14 +26,17 @@ Support is divided into three tiers:
   the broader community.
 * **Tier 2**: Full test coverage but more limited maintenance,
   often provided by the vendor of the platform.
-* **Experimental**: Known to compile but not necessarily reliably or with
-  a full passing test suite. These are often working to be promoted to Tier
-  2 but are not quite ready. There is at least one individual actively
-  providing maintenance and the team is striving to broaden quality and
-  reliability of support.
+* **Experimental**: May not compile reliably or test suite may not pass.
+  These are often working to be promoted to Tier 2 but are not quite ready.
+  There is at least one individual actively providing maintenance and the team
+  is striving to broaden quality and reliability of support.
 
 ### Supported platforms
 
+The community does not build or test against end of life distributions (EoL).
+Thus we do not recommend that you use Node on end of life or unsupported platforms
+in production.
+
 |  System      | Support type | Version                          | Architectures        | Notes            |
 |--------------|--------------|----------------------------------|----------------------|------------------|
 | GNU/Linux    | Tier 1       | kernel >= 2.6.18, glibc >= 2.5   | x86, x64, arm, arm64 |                  |
@@ -63,8 +66,8 @@ Depending on host platform, the selection of toolchains may vary.
 
 #### Unix
 
-* GCC 4.8 or newer
-* Clang 3.4 or newer
+* GCC 4.8.5 or newer
+* Clang 3.4.2 or newer
 
 #### Windows
 
@@ -79,24 +82,23 @@ Depending on host platform, the selection of toolchains may vary.
 Prerequisites:
 
 * `gcc` and `g++` 4.8.5 or newer, or
-* `clang` and `clang++` 3.4 or newer
+* `clang` and `clang++` 3.4.2 or newer
 * Python 2.6 or 2.7
 * GNU Make 3.81 or newer
 
-On macOS, you will also need:
-* [Xcode](https://developer.apple.com/xcode/download/)
-  - You also need to install the `Command Line Tools` via Xcode. You can find
-    this under the menu `Xcode -> Preferences -> Downloads`
-  - This step will install `gcc` and the related toolchain containing `make`
-
-* After building, you may want to setup [firewall rules](tools/macosx-firewall.sh)
+On macOS you will need to install the `Xcode Command Line Tools` by running
+`xcode-select --install`. Alternatively, if you already have the full Xcode
+installed, you can find them under the menu `Xcode -> Open Developer Tool ->
+More Developer Tools...`. This step will install `clang`, `clang++`, and
+`make`.
+* You may want to setup [firewall rules](tools/macosx-firewall.sh)
 to avoid popups asking to accept incoming network connections when running tests:
 
 ```console
 $ sudo ./tools/macosx-firewall.sh
 ```
 Running this script will add rules for the executable `node` in the out
-directory and the symbolic `node` link in the projects root directory.
+directory and the symbolic `node` link in the project's root directory.
 
 On FreeBSD and OpenBSD, you may also need:
 * libexecinfo
@@ -121,17 +123,8 @@ and not a newer version.
 
 To run the tests:
 
-```console
-$ make test
 ```
-
-To run the npm test suite:
-
-*note: to run the suite on node v4 or earlier you must first*
-*run `make install`*
-
-```console
-$ make test-npm
+$ make test
 ```
 
 To build the documentation:
@@ -206,9 +199,9 @@ in the current continuous integration environment. The participation of people
 dedicated and determined to improve Android building, testing, and support is
 encouraged.
 
-Be sure you have downloaded and extracted [Android NDK]
-(https://developer.android.com/tools/sdk/ndk/index.html)
-before in a folder. Then run:
+Be sure you have downloaded and extracted
+[Android NDK](https://developer.android.com/tools/sdk/ndk/index.html) before in
+a folder. Then run:
 
 ```console
 $ ./android-configure /path/to/your/android-ndk
@@ -350,6 +343,6 @@ and [user guide](https://openssl.org/docs/fips/UserGuide-2.0.pdf).
 6. Get into Node.js checkout folder
 7. `./configure --openssl-fips=/path/to/openssl-fips/installdir`
    For example on ubuntu 12 the installation directory was
-   /usr/local/ssl/fips-2.0
+   `/usr/local/ssl/fips-2.0`
 8. Build Node.js with `make -j`
-9. Verify with `node -p "process.versions.openssl"` (`1.0.2a-fips`)
+9. Verify with `node -p "process.versions.openssl"` (for example `1.0.2a-fips`)

CHANGELOG.md

@@ -26,7 +26,8 @@ release.
 </tr>
 <tr>
   <td valign="top">
-<b><a href="doc/changelogs/CHANGELOG_V6.md#6.11.1">6.11.1</a></b><br/>
+<b><a href="doc/changelogs/CHANGELOG_V6.md#6.11.2">6.11.2</a></b><br/>
+<a href="doc/changelogs/CHANGELOG_V6.md#6.11.1">6.11.1</a><br/>
 <a href="doc/changelogs/CHANGELOG_V6.md#6.11.0">6.11.0</a><br/>
 <a href="doc/changelogs/CHANGELOG_V6.md#6.10.3">6.10.3</a><br/>
 <a href="doc/changelogs/CHANGELOG_V6.md#6.10.2">6.10.2</a><br/>

COLLABORATOR_GUIDE.md

@@ -4,6 +4,7 @@
 
 * [Issues and Pull Requests](#issues-and-pull-requests)
 * [Accepting Modifications](#accepting-modifications)
+   - [Useful CI Jobs](#useful-ci-jobs)
    - [Internal vs. Public API](#internal-vs-public-api)
    - [Breaking Changes](#breaking-changes)
    - [Deprecations](#deprecations)
@@ -87,6 +88,31 @@ All pull requests that modify executable code should be subjected to
 continuous integration tests on the
 [project CI server](https://ci.nodejs.org/).
 
+#### Useful CI Jobs
+
+* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
+is the standard CI run we do to check Pull Requests. It triggers `node-test-commit`,
+which runs the `build-ci` and `test-ci` targets on all supported platforms.
+
+* [`node-test-linter`](https://ci.nodejs.org/job/node-test-linter/)
+only runs the linter targets, which is useful for changes that only affect comments
+or documentation.
+
+* [`citgm-smoker`](https://ci.nodejs.org/job/citgm-smoker/)
+uses [`CitGM`](https://github.com/nodejs/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. To test Node.JS ABI changes
+you can run [`citgm-abi-smoker`](https://ci.nodejs.org/job/citgm-abi-smoker/).
+
+* [`node-stress-single-test`](https://ci.nodejs.org/job/node-stress-single-test/)
+is designed to allow one to run a group of tests over and over on a specific
+platform to confirm that the test is reliable.
+
+* [`node-test-commit-v8-linux`](https://ci.nodejs.org/job/node-test-commit-v8-linux/)
+is designed to allow validation of changes to the copy of V8 in the Node.js
+tree by running the standard V8 tests. It should be run whenever the
+level of V8 within Node.js is updated or new patches are floated on V8.
+
 ### Internal vs. Public API
 
 Due to the nature of the JavaScript language, it can often be difficult to
@@ -230,6 +256,13 @@ not can often be based on many complex factors that are not easily codified. It
 is also possible that the breaking commit can be labeled retroactively as a
 semver-major change that will not be backported to Current or LTS branches.
 
+##### Reverting commits
+
+Commits are reverted with `git revert <HASH>`, or `git revert <FROM>..<TO>` for
+multiple commits. Commit metadata and the reason for the revert should be
+appended. Commit message rules about line length and subsystem can be ignored.
+A Pull Request should be raised and approved like any other change.
+
 ### Deprecations
 
 Deprecation refers to the identification of Public APIs that should no longer

CONTRIBUTING.md

@@ -38,7 +38,7 @@ copy locally.
 ```text
 $ git clone [email protected]:username/node.git
 $ cd node
-$ git remote add upstream git://github.com/nodejs/node.git
+$ git remote add upstream https://github.com/nodejs/node.git
 ```
 
 #### Which branch?
@@ -182,7 +182,14 @@ If you are updating tests and just want to run a single test to check it, you
 can use this syntax to run it exactly as the test harness would:
 
 ```text
-$ python tools/test.py -v --mode=release parallel/test-stream2-transform
+$ python tools/test.py -J --mode=release parallel/test-stream2-transform
+```
+
+If you want to check the other options, please refer to the help by using
+the `--help` option
+
+```text
+$ python tools/test.py --help
 ```
 
 You can run tests directly with node: