diff options
| author | Wyatt Preul <wpreul@gmail.com> | 2016-03-12 00:03:25 +0300 |
|---|---|---|
| committer | Wyatt Preul <wpreul@gmail.com> | 2016-03-13 20:04:58 +0300 |
| commit | 4c4d9aeff14b934749fc8562ad15438da1da515a (patch) | |
| tree | 56ddcfae0dc40a82eec02558059e5bda0b7a06b1 /COLLABORATOR_GUIDE.md | |
| parent | f2bd9cddee3be220f00527e9a08f0ea78e7bb88b (diff) | |
collaborator_guide: clarify commit message rules
Italicize the full URL being required in metadata.
PR-URL: https://github.com/nodejs/node/pull/5661
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James Snell <jasnell@gmail.com>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 4e3077163d8..90d73e80e96 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -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. |