From fab79c1a250db252baa206f59d7e46986e21a57c Mon Sep 17 00:00:00 2001 From: MarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz> Date: Tue, 20 May 2025 18:42:29 +0200 Subject: [PATCH] doc: Clarify and move "hygienic commit" note The prior version mentions to update the tests *first*, which is wrong. It must be updated at the same time in the same commit. --- CONTRIBUTING.md | 1 + doc/developer-notes.md | 3 --- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25637b40aa9..56843452a1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -115,6 +115,7 @@ fixes or code moves with actual code changes. Make sure each individual commit is hygienic: that it builds successfully on its own without warnings, errors, regressions, or test failures. +This means tests must be updated in the same commit that changes the behavior. Commit messages should be verbose by default consisting of a short subject line (50 chars max), a blank line and detailed explanatory text as separate diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 59ed36bc3b2..ce6ea7e0596 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -805,9 +805,6 @@ General Bitcoin Core on the master branch. Otherwise, all new pull requests will start failing the tests, resulting in confusion and mayhem. - - *Explanation*: If the test suite is to be updated for a change, this has to - be done first. - Logging -------