From ff66b0854970c52c608581159343c00ba6fabc7f Mon Sep 17 00:00:00 2001 From: Jesus Hernandez Date: Sun, 18 Apr 2021 19:51:27 +0200 Subject: [PATCH 1/3] Remove request of rebase to fixup commits to follow recommendation of rust-highfive bot The bot comment: "If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes." --- src/contributing.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index abe1bb839..e6138eef8 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -144,8 +144,7 @@ CI will also run tidy and will fail if tidy fails. Rust follows a _no merge-commit policy_, meaning, when you encounter merge conflicts you are expected to always rebase instead of merging. E.g. always use rebase when bringing the latest changes from the master branch to your feature -branch. Also, please make sure that fixup commits are squashed into other -related commits with meaningful commit messages. +branch. If you encounter merge conflicts, your PR will get marked as `S-waiting-on-author`. When you resolve them, you should use `@rustbot` to mark it as `S-waiting-on-review`. From 2b47fd360de669dce8013fb2c7cbfb84b118875b Mon Sep 17 00:00:00 2001 From: Jesus Hernandez Date: Sun, 18 Apr 2021 19:59:58 +0200 Subject: [PATCH 2/3] Remove suggestions about rebase to fixup or add additional changes requested To avoid confusion with the recommendation of rust-highfive bot --- src/git.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/git.md b/src/git.md index e533426cf..1f2a24326 100644 --- a/src/git.md +++ b/src/git.md @@ -238,8 +238,7 @@ rebase! Use `git push --force-with-lease` instead. ## Advanced Rebasing -If your branch contains multiple consecutive rewrites of the same code, or if -the rebase conflicts are extremely severe, you can use +If your branch conflicts are extremely severe, you can use `git rebase --interactive master` to gain more control over the process. This allows you to choose to skip commits, edit the commits that you do not skip, change the order in which they are applied, or "squash" them into each other. @@ -259,8 +258,7 @@ commit. Both the upside and downside of this is that it simplifies the history. On the one hand, you lose track of the steps in which changes were made, but the history becomes easier to work with. -You also may want to squash just the last few commits together, possibly -because they only represent "fixups" and not real changes. For example, +You also may want to squash just the last few commits together. For example, `git rebase --interactive HEAD~2` will allow you to edit the two commits only. ## No-Merge Policy From a4e4ddbf2d8433fe6673cc0759873fda498b0d8e Mon Sep 17 00:00:00 2001 From: Jesus Hernandez Date: Sun, 18 Apr 2021 23:58:59 +0200 Subject: [PATCH 3/3] Revert deletion of tips that does not produce confusion about guidelines to new contributors --- src/git.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/git.md b/src/git.md index 1f2a24326..e533426cf 100644 --- a/src/git.md +++ b/src/git.md @@ -238,7 +238,8 @@ rebase! Use `git push --force-with-lease` instead. ## Advanced Rebasing -If your branch conflicts are extremely severe, you can use +If your branch contains multiple consecutive rewrites of the same code, or if +the rebase conflicts are extremely severe, you can use `git rebase --interactive master` to gain more control over the process. This allows you to choose to skip commits, edit the commits that you do not skip, change the order in which they are applied, or "squash" them into each other. @@ -258,7 +259,8 @@ commit. Both the upside and downside of this is that it simplifies the history. On the one hand, you lose track of the steps in which changes were made, but the history becomes easier to work with. -You also may want to squash just the last few commits together. For example, +You also may want to squash just the last few commits together, possibly +because they only represent "fixups" and not real changes. For example, `git rebase --interactive HEAD~2` will allow you to edit the two commits only. ## No-Merge Policy