Skip to content

Commit

Permalink
doc: explains why Reviewed-By is added in PRs
Browse files Browse the repository at this point in the history
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: #8893
PR-URL: #9044
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
jalafel authored and Myles Borins committed Oct 14, 2016
1 parent c2984ce commit 98934d2
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ information regarding the change process:

- A `Reviewed-By: Name <email>` 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.
Expand Down

0 comments on commit 98934d2

Please sign in to comment.