Skip to content

Commit 4c4d9ae

Browse files
committed
collaborator_guide: clarify commit message rules
Italicize the full URL being required in metadata. PR-URL: nodejs#5661 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James Snell <[email protected]>
1 parent f2bd9cd commit 4c4d9ae

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

COLLABORATOR_GUIDE.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,17 @@ information regarding the change process:
9393

9494
- A `Reviewed-By: Name <email>` line for yourself and any
9595
other Collaborators who have reviewed the change.
96-
- A `PR-URL:` line that references the full GitHub URL of the original
96+
- A `PR-URL:` line that references the *full* GitHub URL of the original
9797
pull request being merged so it's easy to trace a commit back to the
9898
conversation that led up to that change.
99-
- A `Fixes: X` line, where _X_ is either includes the full GitHub URL
99+
- A `Fixes: X` line, where _X_ either includes the *full* GitHub URL
100100
for an issue, and/or the hash and commit message if the commit fixes
101101
a bug in a previous commit. Multiple `Fixes:` lines may be added if
102102
appropriate.
103103

104+
Review the commit message to ensure that it adheres to the guidelines
105+
outlined in the [contributing](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit) guide.
106+
104107
See the commit log for examples such as
105108
[this one](https://github.com/nodejs/node/commit/b636ba8186) if unsure
106109
exactly how to format your commit messages.

0 commit comments

Comments
 (0)