From 0a2a39cb951a5fdcc119796f36a8997d919fbc12 Mon Sep 17 00:00:00 2001 From: jessicaquynh Date: Tue, 11 Oct 2016 21:38:06 -0400 Subject: [PATCH] doc: explains why Reviewed-By is added in PRs Adds verbose reasons to the documentation on why the Reviewed-By metadata on a pull request is important. This was loosely mentioned as an issue in the referenced issue below, and answered by @addaleax. Ref: https://github.com/nodejs/node/issues/8893 PR-URL: https://github.com/nodejs/node/pull/9044 Reviewed-By: Myles Borins Reviewed-By: Stephen Belanger Reviewed-By: Luigi Pinca --- COLLABORATOR_GUIDE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 2bab2e2031..5d0bfbfbb4 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -101,6 +101,8 @@ information regarding the change process: - 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. + - Protects against the assumption that GitHub will be around forever. - 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.