doc: add squash guideline to pull-requests doc

Tell the contributor to generally not squash commits during the pull request review process. PR-URL: #20413 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · May 3, 2018 · 24a5ac7 · 24a5ac7
1 parent ac6d1f2
commit 24a5ac7
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md
@@ -599,9 +599,10 @@ whether the failure was caused by the changes in the Pull Request.
 
 ### Commit Squashing
 
-When the commits in your Pull Request land, they may be squashed
-into one commit per logical change. Metadata will be added to the commit
-message (including links to the Pull Request, links to relevant issues,
+In most cases, do not squash commits that you add to your Pull Request during
+the review process. When the commits in your Pull Request land, they may be
+squashed into one commit per logical change. Metadata will be added to the
+commit message (including links to the Pull Request, links to relevant issues,
 and the names of the reviewers). The commit history of your Pull Request,
 however, will stay intact on the Pull Request page.