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]>
nodejs · Nov 11, 2016 · af645a0 · af645a0
1 parent a7ae887
commit af645a0
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/doc/onboarding.md b/doc/onboarding.md
@@ -164,8 +164,15 @@ onboarding session.
 
 ## Landing PRs: Details
 
-* Please never use GitHub's green "Merge Pull Request" button.
+* 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.
   * If you do, please force-push removing the merge.
+  * Reasons for not using the web interface button:
+    * The merge method will add an unnecessary merge commit.
+    * The rebase & merge method adds metadata to the commit title.
+    * The rebase method changes the author.
+    * The squash & merge method has been known to add metadata to the commit title.
+    * If more than one author has contributed to the PR, only the latest author will be considered during the squashing.
+
 
 Update your `master` branch (or whichever branch you are landing on, almost always `master`)