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