Permalink
Browse files

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 <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information...
Trott committed Apr 30, 2018
1 parent ac6d1f2 commit 24a5ac797d6eb2431d532ddb3a9e2062490a7737
Showing with 4 additions and 3 deletions.
  1. +4 −3 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.

0 comments on commit 24a5ac7

Please sign in to comment.