Skip to content

Commit 4f454bd

Browse files
joyeecheungaddaleax
authored andcommitted
doc: mention git-node in the collaborator guide
PR-URL: #18960 Fixes: #18197 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Matheus Marchini <[email protected]> Reviewed-By: Shingo Inoue <[email protected]>
1 parent 4bc5423 commit 4f454bd

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

COLLABORATOR_GUIDE.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- [Deprecations](#deprecations)
2222
- [Involving the TSC](#involving-the-tsc)
2323
* [Landing Pull Requests](#landing-pull-requests)
24+
- [Using `git-node`](#using-git-node)
2425
- [Technical HOWTO](#technical-howto)
2526
- [Troubleshooting](#troubleshooting)
2627
- [I Just Made a Mistake](#i-just-made-a-mistake)
@@ -454,6 +455,26 @@ Additionally:
454455
- All commits should be self-contained (meaning every commit should pass all
455456
tests). This makes it much easier when bisecting to find a breaking change.
456457

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+
457478
### Technical HOWTO
458479

459480
Clear any `am`/`rebase` that may already be underway:
@@ -569,7 +590,8 @@ commit logs, ensure that they are properly formatted, and add
569590

570591
<a name="metadata"></a>
571592
* 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.)
573595

574596
* Required: A `PR-URL:` line that references the *full* GitHub URL of the
575597
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.
748770
[Stability Index]: doc/api/documentation.md#stability-index
749771
[Enhancement Proposal]: https://github.com/nodejs/node-eps
750772
[`--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
751775
[git-username]: https://help.github.com/articles/setting-your-username-in-git/
752776
[`node-core-utils`]: https://github.com/nodejs/node-core-utils
753777
[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

Comments
 (0)