Skip to content

Commit

Permalink
collaborator_guide: clarify commit message rules
Browse files Browse the repository at this point in the history
Italicize the full URL being required in metadata.

PR-URL: #5661
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: James Snell <[email protected]>
  • Loading branch information
geek committed Mar 13, 2016
1 parent f2bd9cd commit 4c4d9ae
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,17 @@ information regarding the change process:

- A `Reviewed-By: Name <email>` line for yourself and any
other Collaborators who have reviewed the change.
- A `PR-URL:` line that references the full GitHub URL of the original
- 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 the
conversation that led up to that change.
- A `Fixes: X` line, where _X_ is either includes the full GitHub URL
- A `Fixes: X` line, where _X_ either includes the *full* GitHub URL
for an issue, and/or the hash and commit message if the commit fixes
a bug in a previous commit. Multiple `Fixes:` lines may be added if
appropriate.

Review the commit message to ensure that it adheres to the guidelines
outlined in the [contributing](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit) guide.

See the commit log for examples such as
[this one](https://github.com/nodejs/node/commit/b636ba8186) if unsure
exactly how to format your commit messages.
Expand Down

2 comments on commit 4c4d9ae

@rvagg
Copy link
Member

@rvagg rvagg commented on 4c4d9ae Mar 14, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should have been "doc:" not "collaborator_guide:" fwiw

@geek
Copy link
Member Author

@geek geek commented on 4c4d9ae Mar 14, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rvagg, thanks... I wasn't sure on that either :) This could also go into the lint rules for commit messages if we make a tool to help with that.

Please sign in to comment.