Skip to content

Commit eefdade

Browse files
MarcoFalkeRandyMcMillan
authored andcommitted
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.
1 parent 81a7420 commit eefdade

File tree

2 files changed

+1
-3
lines changed

2 files changed

+1
-3
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ fixes or code moves with actual code changes.
115115

116116
Make sure each individual commit is hygienic: that it builds successfully on its
117117
own without warnings, errors, regressions, or test failures.
118+
This means tests must be updated in the same commit that changes the behavior.
118119

119120
Commit messages should be verbose by default consisting of a short subject line
120121
(50 chars max), a blank line and detailed explanatory text as separate

doc/developer-notes.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -804,9 +804,6 @@ General Bitcoin Core
804804
on the master branch. Otherwise, all new pull requests will start failing the tests, resulting in
805805
confusion and mayhem.
806806

807-
- *Explanation*: If the test suite is to be updated for a change, this has to
808-
be done first.
809-
810807
Logging
811808
-------
812809

0 commit comments

Comments
 (0)