about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2025-07-17 11:32:43 +0200
committerRalf Jung <post@ralfj.de>2025-07-17 11:32:43 +0200
commit1205c539463c939cfb684b8acbf85ee700dd24b0 (patch)
tree75b6b125bc254b9bd22fc38dc6ef334592cbf5f1
parent6728da5396b3ac80e2b6b53027c4f7cea4dbba02 (diff)
downloadrust-1205c539463c939cfb684b8acbf85ee700dd24b0.tar.gz
rust-1205c539463c939cfb684b8acbf85ee700dd24b0.zip
tweak PR process description
-rw-r--r--src/tools/miri/CONTRIBUTING.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/src/tools/miri/CONTRIBUTING.md b/src/tools/miri/CONTRIBUTING.md
index e4302b734aa..bef3ffe7e95 100644
--- a/src/tools/miri/CONTRIBUTING.md
+++ b/src/tools/miri/CONTRIBUTING.md
@@ -19,10 +19,14 @@ When you get a review, please take care of the requested changes in new commits.
 existing commits. Generally avoid force-pushing. The only time you should force push is when there
 is a conflict with the master branch (in that case you should rebase across master, not merge), and
 all the way at the end of the review process when the reviewer tells you that the PR is done and you
-should squash the commits. If you are unsure how to use `git rebase` to squash commits, use `./miri
-squash` which automates the process but leaves little room for customization. (All this is to work
-around the fact that Github is quite bad at dealing with force pushes and does not support `git
-range-diff`. Maybe one day Github will be good at git and then life can become easier.)
+should squash the commits. (All this is to work around the fact that Github is quite bad at
+dealing with force pushes and does not support `git range-diff`.)
+
+The recommended way to squash commits is to use `./miri squash`, which will make everything into a
+single commit. You will be asked for the commit message; please ensure it describes the entire PR.
+You can also use `git rebase` manually if you need more control (e.g. if there should be more than
+one commit at the end), but then please use `--keep-base` to ensure the PR remains based on the same
+upstream commit.
 
 Most PRs bounce back and forth between the reviewer and the author several times, so it is good to
 keep track of who is expected to take the next step. We are using the `S-waiting-for-review` and