git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] SubmittingPatches: avoid add-failing-test-then-fix anti-pattern

From
Jon Simons <jon@jonsimons.org>
Date
Oct 12, 2026, 03:00 UTC
Message-ID
<20261012030029.12200-1-jon@jonsimons.org>
In-Reply-To
<20261011153206.72386-1-jon@jonsimons.org>

Document the preference to avoid the 'add a failing test and fix it in a subsequent commit' anti-pattern. Although such a sequence is fine for local development, reviewers instead prefer a single commit that introduces the test together with its code change [1].

The goal of this addition is to capture the preference in writing, with hopes of optimizing future review flows by reducing back-and-forths to the list.

[1] A couple examples of feedback, with rationale for avoiding
    the pattern, from August 2025 here:
    - https://lore.kernel.org/git/xmqqqzxpzo8b.fsf@gitster.g/
    - https://lore.kernel.org/git/xmqqfrdk3aqy.fsf@gitster.g/
Signed-off-by: Jon Simons <jon@jonsimons.org>
---
 Documentation/SubmittingPatches | 9 +++++++++
 1 file changed, 9 insertions(+)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index c60855f706..3238a33932 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -271,6 +271,15 @@ fixed by accident to avoid regression.  Also, try merging your work to
 that are still in flight may have unexpected interactions with what
 you are trying to do in your topic.
 
+A bugfix patch should include tests in test_expect_success() blocks that
+demonstrate the breakage when the code change that implements the fix is
+omitted.  Submit tests as `test_expect_success` in the same commit as
+your code change that fixes the bug.  A separate commit that only changes
+`test_expect_failure` to `test_expect_success` can leave the behavior
+being tested out of the diff context, making the fix harder to review.
+Reviewers who want to verify that your test reproduces the bug can
+temporarily undo the code changes while keeping the test.
+
 Pushing to a fork of https://github.com/git/git will use their CI
 integration to test your changes on Linux, Mac and Windows. See the
 <<GHCI,GitHub CI>> section for details.
-- 
2.55.0
Previous: Jon SimonsNext: Junio C Hamano
Message 5 of 6 in “SubmittingPatches: avoid add-failing-test-then-fix anti-pattern”
  1. SubmittingPatches: avoid add-failing-test-then-fix anti-patternJon Simons, Oct 11, 2026
  2. Kristoffer HaugsbakkOct 11, 2026
  3. Junio C HamanoOct 11, 2026
  4. Jon SimonsOct 12, 2026
  5. SubmittingPatches: avoid add-failing-test-then-fix anti-patternJon Simons, Oct 12, 2026
  6. Junio C HamanoOct 12, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.