diff options
| author | Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> | 2023-01-02 07:31:31 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-02 07:31:31 -0800 |
| commit | 5bfd60ba35bc30a6f881c5f104f55c6f275fa7f3 (patch) | |
| tree | 533b35f665eb3c7060332f71553d72f7ff79a7d2 /contributors/guide | |
| parent | 8d1abadf37c02545a8ecccf6bc196f958e10c37e (diff) | |
| parent | a30a95d2ffd104522714ad939f5da5c120675b22 (diff) | |
Merge pull request #6667 from fsmunoz/prow-and-tide-squashing
Add tide/merge-method-squash option for automated squashing
Diffstat (limited to 'contributors/guide')
| -rw-r--r-- | contributors/guide/github-workflow.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/contributors/guide/github-workflow.md b/contributors/guide/github-workflow.md index 178c5854..a50b3a66 100644 --- a/contributors/guide/github-workflow.md +++ b/contributors/guide/github-workflow.md @@ -237,6 +237,11 @@ For mass automated fixups such as automated doc formatting, use one or more commits for the changes to tooling and a final commit to apply the fixup en masse. This makes reviews easier. +An alternative to this manual squashing process is to use the Prow and Tide based automation that is configured in GitHub: adding a comment to your PR with `/label tide/merge-method-squash` will trigger the automation so that GitHub squash your commits onto the target branch once the PR is approved. Using this approach simplifies things for those less familiar with Git, but there are situations in where it's better to squash locally; reviewers will have this in mind and can ask for manual squashing to be done. + +By squashing locally, you control the commit message(s) for your work, and can separate a large PR into logically separate changes. +For example: you have a pull request that is code complete and has 24 commits. You rebase this against the same merge base, simplifying the change to two commits. Each of those two commits represents a single logical change and each commit message summarizes what changes. Reviewers see that the set of changes are now understandable, and approve your PR. + ## Merging a commit Once you've received review and approval, your commits are squashed, your PR is ready for merging. |