From 48712ac0162580af7e8aaed98fca0b8e4670a6b9 Mon Sep 17 00:00:00 2001 From: Gibson Fahnestock Date: Fri, 6 Jan 2017 22:46:39 +0000 Subject: [PATCH] doc: document use of Refs: for references Standardise on Refs: PR-URL: https://github.com/nodejs/node/pull/10670 Reviewed-By: James M Snell Reviewed-By: Yorkie Liu Reviewed-By: Luigi Pinca Reviewed-By: Joyee Cheung Reviewed-By: Sam Roberts --- COLLABORATOR_GUIDE.md | 1 + CONTRIBUTING.md | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 32533304fecc67..b80e1d5db02f7d 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -120,6 +120,7 @@ information regarding the change process: 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. +- A `Refs:` line referencing a URL for any relevant background. - A `Reviewed-By: Name ` line for yourself and any other Collaborators who have reviewed the change. - Useful for @mentions / contact list if something goes wrong in the PR. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f198c82ee2f2f1..736a9542c42baf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -136,10 +136,13 @@ Check the output of `git log --oneline files_that_you_changed` to find out what subsystem (or subsystems) your changes touch. If your patch fixes an open issue, you can add a reference to it at the end -of the log. Use the `Fixes:` prefix and the full issue URL. For example: +of the log. Use the `Fixes:` prefix and the full issue URL. For other references +use `Refs:`. For example: ```txt Fixes: https://github.com/nodejs/node/issues/1337 +Refs: http://eslint.org/docs/rules/space-in-parens.html +Refs: https://github.com/nodejs/node/pull/3615 ``` ### Step 4: Rebase