|
21 | 21 | - [Deprecations](#deprecations)
|
22 | 22 | - [Involving the TSC](#involving-the-tsc)
|
23 | 23 | * [Landing Pull Requests](#landing-pull-requests)
|
| 24 | + - [Using `git-node`](#using-git-node) |
24 | 25 | - [Technical HOWTO](#technical-howto)
|
25 | 26 | - [Troubleshooting](#troubleshooting)
|
26 | 27 | - [I Just Made a Mistake](#i-just-made-a-mistake)
|
@@ -454,6 +455,26 @@ Additionally:
|
454 | 455 | - All commits should be self-contained (meaning every commit should pass all
|
455 | 456 | tests). This makes it much easier when bisecting to find a breaking change.
|
456 | 457 |
|
| 458 | +### Using `git-node` |
| 459 | + |
| 460 | +In most cases, using [the `git-node` command][git-node] of [`node-core-utils`][] |
| 461 | +should be enough to help you land a Pull Request. If you discover a problem when |
| 462 | +using this tool, please file an issue |
| 463 | +[to the issue tracker][node-core-utils-issues]. |
| 464 | + |
| 465 | +Quick example: |
| 466 | + |
| 467 | +```text |
| 468 | +$ npm install -g node-core-utils |
| 469 | +$ git node land $PRID |
| 470 | +``` |
| 471 | + |
| 472 | +If it's the first time you ever use `node-core-utils`, you will be prompted |
| 473 | +to type the password of your GitHub account in the console so the tool can |
| 474 | +create the GitHub access token for you. If you do not want to do that, follow |
| 475 | +[the guide of `node-core-utils`][node-core-utils-credentials] |
| 476 | +to set up your credentials manually. |
| 477 | + |
457 | 478 | ### Technical HOWTO
|
458 | 479 |
|
459 | 480 | Clear any `am`/`rebase` that may already be underway:
|
@@ -569,7 +590,8 @@ commit logs, ensure that they are properly formatted, and add
|
569 | 590 |
|
570 | 591 | <a name="metadata"></a>
|
571 | 592 | * Modify the original commit message to include additional metadata regarding
|
572 |
| - the change process. ([`node-core-utils`][] fetches the metadata for you.) |
| 593 | + the change process. (The [`git node metadata`][git-node-metadata] command |
| 594 | + can generate the metadata for you.) |
573 | 595 |
|
574 | 596 | * Required: A `PR-URL:` line that references the *full* GitHub URL of the
|
575 | 597 | original pull request being merged so it's easy to trace a commit back to
|
@@ -748,6 +770,10 @@ LTS working group and the Release team.
|
748 | 770 | [Stability Index]: doc/api/documentation.md#stability-index
|
749 | 771 | [Enhancement Proposal]: https://github.com/nodejs/node-eps
|
750 | 772 | [`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation
|
| 773 | +[git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md |
| 774 | +[git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata |
751 | 775 | [git-username]: https://help.github.com/articles/setting-your-username-in-git/
|
752 | 776 | [`node-core-utils`]: https://github.com/nodejs/node-core-utils
|
753 | 777 | [TSC]: https://github.com/nodejs/TSC
|
| 778 | +[node-core-utils-issues]: https://github.com/nodejs/node-core-utils/issues |
| 779 | +[node-core-utils-credentials]: https://github.com/nodejs/node-core-utils#setting-up-credentials |
0 commit comments