1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: recommend node-core-utils for metadata

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Rich Trott 2017-11-12 16:29:27 -08:00 committed by James M Snell
parent 29de91b64f
commit d96852027c
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
COLLABORATOR_GUIDE.md
View File

@ -501,8 +501,7 @@ commit logs, ensure that they are properly formatted, and add
<a name="metadata"></a> <a name="metadata"></a>
* Modify the original commit message to include additional metadata regarding * Modify the original commit message to include additional metadata regarding
the change process. (If you use Chrome or Edge, [`node-review`][] fetches the change process. ([`node-core-utils`][] fetches the metadata for you.)
the metadata for you.)
* Required: A `PR-URL:` line that references the *full* GitHub URL of the * 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 original pull request being merged so it's easy to trace a commit back to
@ -681,4 +680,4 @@ LTS working group and the Release team.
[Stability Index]: doc/api/documentation.md#stability-index [Stability Index]: doc/api/documentation.md#stability-index
[Enhancement Proposal]: https://github.com/nodejs/node-eps [Enhancement Proposal]: https://github.com/nodejs/node-eps
[git-username]: https://help.github.com/articles/setting-your-username-in-git/ [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
doc/onboarding.md
View File

@ -158,7 +158,7 @@ onboarding session.
* After one or two approvals, land the PR. * After one or two approvals, land the PR.
* Be sure to add the `PR-URL: <full-pr-url>` and appropriate `Reviewed-By:` metadata! * 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! * [`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 ## Final notes
@ -180,4 +180,4 @@ onboarding session.
[Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md [Code of Conduct]: https://github.com/nodejs/TSC/blob/master/CODE_OF_CONDUCT.md
[`core-validate-commit`]: https://github.com/evanlucas/core-validate-commit [`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