[llvm] [docs] Make rebase advice more explicit for cases where pre-commit CI is failing (PR #76704)

Alex Bradbury via llvm-commits llvm-commits at lists.llvm.org
Tue Jan 2 01:45:48 PST 2024


https://github.com/asb created https://github.com/llvm/llvm-project/pull/76704

You could argue that rebasing if pre-commit CI is failing due to issues unrelated to your patchset is already suggested, but I think it would be beneficial to make this advice more explicit. If pre-commit CI is failing because the base commit you used was bad, you're doing your reviewers a service by rebasing in order to fix that issue.

>From e2a8d8982dd2c4ee8097c926dcb7c4c49aca21b4 Mon Sep 17 00:00:00 2001
From: Alex Bradbury <asb at igalia.com>
Date: Tue, 2 Jan 2024 09:40:04 +0000
Subject: [PATCH] [docs] Make rebase advice more explicit for cases where
 pre-commit CI is failing

You could argue that rebasing if pre-commit CI is failing due to issues
unrelated to your patchset is already suggested, but I think it would be
beneficial to make this advice more explicit. If pre-commit CI is
failing because the base commit you used was bad, you're doing your
reviewers a service by rebasing in order to fix that issue.
---
 llvm/docs/GitHub.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/llvm/docs/GitHub.rst b/llvm/docs/GitHub.rst
index a89a4d955fc08b..8753396b59e293 100644
--- a/llvm/docs/GitHub.rst
+++ b/llvm/docs/GitHub.rst
@@ -105,7 +105,9 @@ branch that's the root of the Pull Request during the review. This action will
 make the context of the old changes and comments harder to find and read.
 
 Sometimes, a rebase might be needed to update your branch with a fix for a test
-or in some dependent code.
+or in some dependent code. This is especially encouraged if it turns out that
+the upstream base commit used for your branch had test failures, meaning the
+pre-commit CI results are not useful.
 
 After your PR is reviewed and accepted, you want to rebase your branch to ensure
 you won't encounter merge conflicts when landing the PR.



More information about the llvm-commits mailing list