-
-
Notifications
You must be signed in to change notification settings - Fork 34.3k
doc: mention git-node in the collaborator guide #18960
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,6 +21,7 @@ | |
| - [Deprecations](#deprecations) | ||
| - [Involving the TSC](#involving-the-tsc) | ||
| * [Landing Pull Requests](#landing-pull-requests) | ||
| - [Using `git-node`](#using-git-node) | ||
| - [Technical HOWTO](#technical-howto) | ||
| - [Troubleshooting](#troubleshooting) | ||
| - [I Just Made a Mistake](#i-just-made-a-mistake) | ||
|
|
@@ -454,6 +455,26 @@ Additionally: | |
| - All commits should be self-contained (meaning every commit should pass all | ||
| tests). This makes it much easier when bisecting to find a breaking change. | ||
|
|
||
| ### Using `git-node` | ||
|
|
||
| In most cases, using [the `git-node` command][git-node] of [`node-core-utils`][] | ||
| should be enough to help you land a Pull Request. If you discover a problem when | ||
| using this tool, please file an issue | ||
| [to the issue tracker][node-core-utils-issues]. | ||
|
|
||
| Quick example: | ||
|
|
||
| ```text | ||
| $ npm install -g node-core-utils | ||
| $ git node land $PRID | ||
| ``` | ||
|
|
||
| If it's the first time you have ever use `node-core-utils`, you will be prompted | ||
| to type the password of your GitHub account in the console so the tool can | ||
| create the GitHub access token for you. If you do not want to do that, follow | ||
| [the guide of `node-core-utils`][node-core-utils-credentials] | ||
| to set up your credentials manually. | ||
|
|
||
| ### Technical HOWTO | ||
|
|
||
| Clear any `am`/`rebase` that may already be underway: | ||
|
|
@@ -569,7 +590,8 @@ commit logs, ensure that they are properly formatted, and add | |
|
|
||
| <a name="metadata"></a> | ||
| * Modify the original commit message to include additional metadata regarding | ||
| the change process. ([`node-core-utils`][] fetches the metadata for you.) | ||
| the change process. (the [`git node metadata`][git-node-metadata] command | ||
|
||
| can generate the metadata for you.) | ||
|
|
||
| * Required: A `PR-URL:` line that references the *full* GitHub URL of the | ||
| 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. | |
| [Stability Index]: doc/api/documentation.md#stability-index | ||
| [Enhancement Proposal]: https://github.com/nodejs/node-eps | ||
| [`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation | ||
| [git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md | ||
| [git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata | ||
| [git-username]: https://help.github.com/articles/setting-your-username-in-git/ | ||
| [`node-core-utils`]: https://github.com/nodejs/node-core-utils | ||
| [TSC]: https://github.com/nodejs/TSC | ||
| [node-core-utils-issues]: https://github.com/nodejs/node-core-utils/issues | ||
| [node-core-utils-credentials]: https://github.com/nodejs/node-core-utils#setting-up-credentials | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: remove "have" ?