From 4cdc3c035db71e325fd49fc4eaa73588f596e6e8 Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Thu, 13 Jul 2023 10:17:16 +0800 Subject: [PATCH 1/4] doc: expand on squashing and rebasing to land a PR --- doc/contributing/collaborator-guide.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index 0ad07f73144a78..e5afcfac2fae1d 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -540,6 +540,11 @@ For pull requests from first-time contributors, be [welcoming](#welcoming-first-time-contributors). Also, verify that their git settings are to their liking. +If the pull request contains several commits, it can be landed with squashing +into one commit or rebasing all the commits. Generally, a collaborator should +land the pull request with squashing. If the pull request has more than one +self-contained subsystem commits, a collaborator may land it with rebasing. + All commits should be self-contained, meaning every commit should pass all tests. This makes it much easier when bisecting to find a breaking change. From d3ae12c0fd952062f45d5b2f75a5d6ebd1b4aa40 Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Thu, 13 Jul 2023 11:14:00 +0800 Subject: [PATCH 2/4] fixup! doc: expand on squashing and rebasing to land a PR --- doc/contributing/collaborator-guide.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index e5afcfac2fae1d..04fe44303171c0 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -540,10 +540,11 @@ For pull requests from first-time contributors, be [welcoming](#welcoming-first-time-contributors). Also, verify that their git settings are to their liking. -If the pull request contains several commits, it can be landed with squashing -into one commit or rebasing all the commits. Generally, a collaborator should -land the pull request with squashing. If the pull request has more than one -self-contained subsystem commits, a collaborator may land it with rebasing. +If the pull request contains more than one commits, it can be landed with +squashing into one commit or rebasing all the commits. Generally, a +collaborator should land the pull request with squashing. If the pull request +has more than one self-contained subsystem commits, a collaborator may land it +with rebasing. All commits should be self-contained, meaning every commit should pass all tests. This makes it much easier when bisecting to find a breaking change. From 45f80af300cb6f56ffe491b9cf9be1ad37755c54 Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Thu, 13 Jul 2023 17:23:03 +0800 Subject: [PATCH 3/4] fixup! doc: expand on squashing and rebasing to land a PR --- doc/contributing/collaborator-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index 04fe44303171c0..aef66d1382bcbc 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -540,8 +540,8 @@ For pull requests from first-time contributors, be [welcoming](#welcoming-first-time-contributors). Also, verify that their git settings are to their liking. -If the pull request contains more than one commits, it can be landed with -squashing into one commit or rebasing all the commits. Generally, a +If the pull request contains more than one commit, it can be landed either by +squashing into one commit or by rebasing all the commits. Generally, a collaborator should land the pull request with squashing. If the pull request has more than one self-contained subsystem commits, a collaborator may land it with rebasing. From 0c4e188b7e3689a3fde59bccf7eee2448310e5cd Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Fri, 14 Jul 2023 10:54:11 +0800 Subject: [PATCH 4/4] fixup! doc: expand on squashing and rebasing to land a PR --- doc/contributing/collaborator-guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index aef66d1382bcbc..a4218acc7d4fd0 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -540,11 +540,11 @@ For pull requests from first-time contributors, be [welcoming](#welcoming-first-time-contributors). Also, verify that their git settings are to their liking. -If the pull request contains more than one commit, it can be landed either by -squashing into one commit or by rebasing all the commits. Generally, a -collaborator should land the pull request with squashing. If the pull request -has more than one self-contained subsystem commits, a collaborator may land it -with rebasing. +If a pull request contains more than one commit, it can be landed either by +squashing into one commit or by rebasing all the commits, or a mix of the two. +Generally, a collaborator should land a pull request by squashing. If a pull +request has more than one self-contained subsystem commits, a collaborator +may land it as several commits. All commits should be self-contained, meaning every commit should pass all tests. This makes it much easier when bisecting to find a breaking change.