Skip to content

Commit

Permalink
doc: add squash guideline to pull-requests doc
Browse files Browse the repository at this point in the history
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 authored and MylesBorins committed May 8, 2018
1 parent 166df9e commit 7a769eb
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/guides/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 7a769eb

Please sign in to comment.