Skip to content

Commit 7a769eb

Browse files
TrottMylesBorins
authored andcommitted
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]>
1 parent 166df9e commit 7a769eb

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/guides/contributing/pull-requests.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -599,9 +599,10 @@ whether the failure was caused by the changes in the Pull Request.
599599

600600
### Commit Squashing
601601

602-
When the commits in your Pull Request land, they may be squashed
603-
into one commit per logical change. Metadata will be added to the commit
604-
message (including links to the Pull Request, links to relevant issues,
602+
In most cases, do not squash commits that you add to your Pull Request during
603+
the review process. When the commits in your Pull Request land, they may be
604+
squashed into one commit per logical change. Metadata will be added to the
605+
commit message (including links to the Pull Request, links to relevant issues,
605606
and the names of the reviewers). The commit history of your Pull Request,
606607
however, will stay intact on the Pull Request page.
607608

0 commit comments

Comments
 (0)