Skip to content

Commit 3af679e

Browse files
jalafelMyles Borins
authored and
Myles Borins
committed
doc: explain why GitHub merge button is not used
Adds documentation and explicit reasons on why the GitHub web interface button is not used. This was explained in the referenced issue by @thealphanerd. Fixes: #8893 PR-URL: #9044 Reviewed-By: Myles Borins <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent ae3f31b commit 3af679e

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

doc/onboarding.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,15 @@ onboarding session.
164164

165165
## Landing PRs: Details
166166

167-
* Please never use GitHub's green "Merge Pull Request" button.
167+
* 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.
169+
* Reasons for not using the web interface button:
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.
173+
* 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.
175+
169176

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

0 commit comments

Comments
 (0)