summaryrefslogtreecommitdiff
path: root/COLLABORATOR_GUIDE.md
diff options
context:
space:
mode:
authorestrada9166 <estrada9166@hotmail.com>2018-02-12 02:31:55 -0500
committerRuben Bridgewater <ruben@bridgewater.de>2018-02-23 16:26:29 +0000
commita29089d7c866955616c0e363843017e9b9b2a736 (patch)
tree28bb543eea1a6bd814da31d854daa8680fdc5a90 /COLLABORATOR_GUIDE.md
parent3a191229418dcc0e21956847993b1702c88a923b (diff)
downloadandroid-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.tar.gz
android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.tar.bz2
android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.zip
doc: add new documentation lint rule
Add 80 characters limit to docs. Change docs to fit 80 characters per row. PR-URL: https://github.com/nodejs/node/pull/18726 Fixes: https://github.com/nodejs/node/issues/18703 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
-rw-r--r--COLLABORATOR_GUIDE.md30
1 files changed, 16 insertions, 14 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md
index 95ef065355..16dff4d3f5 100644
--- a/COLLABORATOR_GUIDE.md
+++ b/COLLABORATOR_GUIDE.md
@@ -154,22 +154,23 @@ The pull request should have a CI status indicator if possible.
#### 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.
+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.
+only runs the linter targets, which is useful for changes that only affect
+comments or documentation.
* [`node-test-pull-request-lite`](https://ci.nodejs.org/job/node-test-pull-request-lite/)
-only runs the linter job, as well as the tests on LinuxONE. Should only be used for
-trivial changes that do not require being tested on all platforms.
+only runs the linter job, as well as the tests on LinuxONE. Should only be used
+for trivial changes that do not require being tested on all platforms.
* [`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/).
+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
@@ -483,8 +484,8 @@ Apply external patches:
$ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am --whitespace=fix
```
-If the merge fails even though recent CI runs were successful, then a 3-way merge may
-be required. In this case try:
+If the merge fails even though recent CI runs were successful, then a 3-way
+merge may be required. In this case try:
```text
$ git am --abort
@@ -492,8 +493,9 @@ $ curl -L https://github.com/nodejs/node/pull/xxx.patch | git am -3 --whitespace
```
If the 3-way merge succeeds you can proceed, but make sure to check the changes
against the original PR carefully and build/test on at least one platform
-before landing. If the 3-way merge fails, then it is most likely that a conflicting
-PR has landed since the CI run and you will have to ask the author to rebase.
+before landing. If the 3-way merge fails, then it is most likely that a
+conflicting PR has landed since the CI run and you will have to ask the author
+to rebase.
Check and re-review the changes: