about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorxizheyin <xizheyin@smail.nju.edu.cn>2025-04-16 13:09:29 +0800
committerxizheyin <xizheyin@smail.nju.edu.cn>2025-04-16 13:09:29 +0800
commit855ecf9a9622db7d92e50f2dfd6d163ef059fa8c (patch)
treed876875a5a233e7dbd389f29c8b6473f5011d996 /src/doc/rustc-dev-guide
parentcbcd28652a78e4d34dfa88ccc5ac40d386dbe567 (diff)
downloadrust-855ecf9a9622db7d92e50f2dfd6d163ef059fa8c.tar.gz
rust-855ecf9a9622db7d92e50f2dfd6d163ef059fa8c.zip
Remind to update dev branch while behind too many commits
Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn>
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/contributing.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/contributing.md b/src/doc/rustc-dev-guide/src/contributing.md
index 09a7f912b98..8c59ac6ef37 100644
--- a/src/doc/rustc-dev-guide/src/contributing.md
+++ b/src/doc/rustc-dev-guide/src/contributing.md
@@ -150,6 +150,20 @@ when contributing to Rust under [the git section](./git.md).
 [t-compiler]: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler
 [triagebot]: https://github.com/rust-lang/rust/blob/master/triagebot.toml
 
+### Keeping your branch up-to-date
+
+The CI in rust-lang/rust applies your patches directly against the current master,
+not against the commit your branch is based on. This can lead to unexpected failures
+if your branch is outdated, even when there are no explicit merge conflicts.
+
+Before submitting or updating a PR, make sure to update your branch
+as mentioned [here](git.md#keeping-things-up-to-date) if it's significantly
+behind the master branch (e.g., more than 100 commits behind).
+This fetches the latest master branch and rebases your changes on top of it,
+ensuring your PR is tested against the latest code.
+
+After rebasing, it's recommended to [run the relevant tests locally](tests/intro.md) to catch any issues before CI runs.
+
 ### r?
 
 All pull requests are reviewed by another person. We have a bot,