diff --git a/doc/guides/collaborator-guide.md b/doc/guides/collaborator-guide.md index 413caf4884b58b..e3d48c09c5338a 100644 --- a/doc/guides/collaborator-guide.md +++ b/doc/guides/collaborator-guide.md @@ -272,10 +272,10 @@ Windows and ARM platforms are only kept for seven days. patches on V8. * [`node-test-commit-custom-suites-freestyle`](https://ci.nodejs.org/job/node-test-commit-custom-suites-freestyle/) - enables customization of test suites and parameters. It can execute test suites - 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`). + enables customization of test suites and parameters. It can execute test + suites 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 Jenkins CI job @@ -676,9 +676,10 @@ $ git rev-list upstream/master...HEAD | xargs core-validate-commit ``` Optional: For your own commits, force push the amended commit to the pull -request branch. If your branch name is `bugfix`, then: `git push --force-with-lease origin master:bugfix`. Don't close the pull request. -It will close after you push it upstream. It will have the purple merged -status rather than the red closed status. If you close the pull request +request branch. If your branch name is `bugfix`, then: +`git push --force-with-lease origin master:bugfix`. Don't close the pull +request. It will close after you push it upstream. It will have the purple +merged status rather than the red closed status. If you close the pull request before GitHub adjusts its status, it will show up as a 0 commit pull request with no changed files. The order of operations is important. If you push upstream before you push to your branch, GitHub will close diff --git a/doc/guides/cpp-style-guide.md b/doc/guides/cpp-style-guide.md index 0f2136dcf7b1e4..2d651049322173 100644 --- a/doc/guides/cpp-style-guide.md +++ b/doc/guides/cpp-style-guide.md @@ -267,7 +267,8 @@ class ExampleClass { When working with typed arrays that involve direct data modification from C++, use an `AliasedBuffer` when possible. The API abstraction and -the usage scope of `AliasedBuffer` are documented in [aliased\_buffer.h][aliased_buffer.h]. +the usage scope of `AliasedBuffer` are documented in +[aliased\_buffer.h][aliased_buffer.h]. ```cpp // Create an AliasedBuffer. diff --git a/doc/guides/maintaining-V8.md b/doc/guides/maintaining-V8.md index 13e33ca6367909..8b79d3b3ca8921 100644 --- a/doc/guides/maintaining-V8.md +++ b/doc/guides/maintaining-V8.md @@ -233,12 +233,17 @@ From the bug we can see that it was merged by V8 into 5.2 and 5.3, and not into V8 5.1 (since it was already abandoned). Since Node.js `v6.x` uses V8 5.1, the fix needed to be cherry-picked. To cherry-pick, here's an example workflow: -* Download and apply the commit linked-to in the issue (in this case a51f429). - `curl -L https://github.com/v8/v8/commit/a51f429.patch | git am -3 --directory=deps/v8`. If the branches have diverged significantly, this may - not apply cleanly. It may help to try to cherry-pick the merge to the oldest - branch that was done upstream in V8. In this example, this would be the patch - from the merge to 5.2. The hope is that this would be closer to the V8 5.1, - and has a better chance of applying cleanly. +* Download and apply the commit linked-to in the issue (in this case a51f429): + + ```console + curl -L https://github.com/v8/v8/commit/a51f429.patch | git am -3 --directory=deps/v8 + ``` + + If the branches have diverged significantly, this may not apply cleanly. It + may help to try to cherry-pick the merge to the oldest branch that was done + upstream in V8. In this example, this would be the patch from the merge to + 5.2. The hope is that this would be closer to the V8 5.1, and has a better + chance of applying cleanly. * Modify the commit message to match the format we use for V8 backports and replace yourself as the author. `git commit --amend --reset-author`. You may want to add extra description if necessary to indicate the impact of the fix diff --git a/doc/guides/maintaining-icu.md b/doc/guides/maintaining-icu.md index 1cb0acc0f8c778..56e5c58aa0f521 100644 --- a/doc/guides/maintaining-icu.md +++ b/doc/guides/maintaining-icu.md @@ -187,10 +187,11 @@ make test-ci * commit the change to `tools/icu/current_ver.dep` and `LICENSE` files. - * Note: To simplify review, I often will “pre-land” this patch, meaning that - I run the patch through `curl -L https://github.com/nodejs/node/pull/xxx.patch | git am -3 --whitespace=fix` per the collaborator’s guide… and then push that - patched branch into my PR's branch. This reduces the whitespace changes that - show up in the PR, since the final land will eliminate those anyway. + * To simplify review, I often will “pre-land” this patch, meaning that I run + `curl -L https://github.com/nodejs/node/pull/xxx.patch | git am -3 --whitespace=fix` + per the collaborator’s guide… and then push that patched branch into my + PR's branch. This reduces the whitespace changes that show up in the PR, + since the final land will eliminate those anyway. ## Floating patches to ICU diff --git a/doc/guides/releases.md b/doc/guides/releases.md index e3ec61219b93a1..11c9a826fee237 100644 --- a/doc/guides/releases.md +++ b/doc/guides/releases.md @@ -466,8 +466,14 @@ tag and pushed it to GitHub, you _**must not**_ delete and re-tag. If you make a mistake after tagging then you'll have to version-bump and start again and count that tag/version as lost. -Tag summaries have a predictable format, look at a recent tag to see, `git tag -v v6.0.0`. The message should look something like `2016-04-26 Node.js v6.0.0 -(Current) Release`. +Tag summaries have a predictable format. Look at a recent tag to see: + +```console +git tag -v v6.0.0 +``` + +The message should look something like +`2016-04-26 Node.js v6.0.0 (Current) Release`. Install `git-secure-tag` npm module: