From d5d64c327b8eb37a263d6e53486de03256b10d31 Mon Sep 17 00:00:00 2001 From: Wyatt Preul Date: Fri, 11 Mar 2016 15:03:25 -0600 Subject: [PATCH] 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 Reviewed-By: James Snell --- COLLABORATOR_GUIDE.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 4e3077163d81e2..90d73e80e9679b 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -93,14 +93,17 @@ information regarding the change process: - A `Reviewed-By: Name ` 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.