mirror/bitcoin
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Clarify and move "hygienic commit" note

Browse Source 
The prior version mentions to update the tests *first*, which is wrong.
It must be updated at the same time in the same commit.
This commit is contained in:
MarcoFalke committed 2025-05-21 16:19:24 +02:00
1 parent fac8b05197
commit fab79c1a25
2 files changed
+1 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CONTRIBUTING.md
+1
View File
@@ -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 Make sure each individual commit is hygienic: that it builds successfully on its
own without warnings, errors, regressions, or test failures. 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 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 (50 chars max), a blank line and detailed explanatory text as separate
doc/developer-notes.md
-3
View File
@@ -805,9 +805,6 @@ General Bitcoin Core
on the master branch. Otherwise, all new pull requests will start failing the tests, resulting in on the master branch. Otherwise, all new pull requests will start failing the tests, resulting in
confusion and mayhem. confusion and mayhem.
- *Explanation*: If the test suite is to be updated for a change, this has to
be done first.
Logging Logging
------- -------