Skip to content

Commit

Permalink
doc: recommend node-core-utils for metadata
Browse files Browse the repository at this point in the history
PR-URL: #16978
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Trott authored and MylesBorins committed Nov 28, 2017
1 parent f226ca6 commit 1bc5c38
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
5 changes: 2 additions & 3 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -495,8 +495,7 @@ 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. (If you use Chrome or Edge, [`node-review`][] fetches
the metadata for you.)
the change process. ([`node-core-utils`][] fetches 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
Expand Down Expand Up @@ -675,4 +674,4 @@ LTS working group and the Release team.
[Stability Index]: doc/api/documentation.md#stability-index
[Enhancement Proposal]: https://github.com/nodejs/node-eps
[git-username]: https://help.github.com/articles/setting-your-username-in-git/
[`node-review`]: https://github.com/evanlucas/node-review
[`node-core-utils`]: https://github.com/nodejs/node-core-utils
4 changes: 2 additions & 2 deletions doc/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ onboarding session.
* After one or two approvals, land the PR.
* Be sure to add the `PR-URL: <full-pr-url>` and appropriate `Reviewed-By:` metadata!
* [`core-validate-commit`][] helps a lot with this – install and use it if you can!
* If you use Chrome or Edge, [`node-review`][] fetches the metadata for you.
* [`node-core-utils`][] fetches the metadata for you.

## Final notes

Expand All @@ -180,4 +180,4 @@ onboarding session.

[Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md
[`core-validate-commit`]: https://github.com/evanlucas/core-validate-commit
[`node-review`]: https://github.com/evanlucas/node-review
[`node-core-utils`]: https://github.com/nodejs/node-core-utils

0 comments on commit 1bc5c38

Please sign in to comment.