Skip to content

Commit 177d880

Browse files
committed
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: #8893 change wording on documentation update Changes the initial commit to the recommended, and more accurate wording. Removed time qualifiers on documentation for git merge removes the ugly wording add a new reason why autosquashing is prohibited
1 parent d42d56f commit 177d880

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

COLLABORATOR_GUIDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ information regarding the change process:
101101

102102
- A `Reviewed-By: Name <email>` line for yourself and any
103103
other Collaborators who have reviewed the change.
104+
- Useful for @mentions / contact list if something goes wrong in the PR.
105+
- Protects against the assumption that GitHub will be around forever.
104106
- A `PR-URL:` line that references the *full* GitHub URL of the original
105107
pull request being merged so it's easy to trace a commit back to the
106108
conversation that led up to that change.

doc/onboarding.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,11 @@ onboarding session.
167167
* Please never use GitHub's green ["Merge Pull Request"](https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-using-the-github-web-interface) button.
168168
* If you do, please force-push removing the merge.
169169
* Reasons for not using the web interface button:
170-
* The old merge method will write an ugly commit message.
171-
* The old rebase & merge method adds metadata to the commit title.
172-
* The latest rebase method changes the author.
170+
* The merge method will add an unnecessary merge commit.
171+
* The rebase & merge method adds metadata to the commit title.
172+
* The rebase method changes the author.
173173
* The squash & merge method has been known to add metadata to the commit title.
174+
* If more than one author has contributed to the PR, only the latest author will be considered during the squashing.
174175

175176

176177
Update your `master` branch (or whichever branch you are landing on, almost always `master`)

0 commit comments

Comments
 (0)