Skip to content

Commit e9e7993

Browse files
committed
Merge #9542: Docs: Update CONTRIBUTING.md
c70622e Docs: Update CONTRIBUTING.md (John Newbery)
2 parents 41cb05c + c70622e commit e9e7993

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,28 @@ about Git.
5353
- Create pull request
5454

5555
The title of the pull request should be prefixed by the component or area that
56-
the pull request affects. Examples:
56+
the pull request affects. Valid areas as:
57+
58+
- *Consensus* for changes to consensus critical code
59+
- *Docs* for changes to the documentation
60+
- *Qt* for changes to bitcoin-qt
61+
- *Mining* for changes to the mining code
62+
- *Net* or *P2P* for changes to the peer-to-peer network code
63+
- *RPC/REST/ZMQ* for changes to the RPC, REST or ZMQ APIs
64+
- *Scripts and tools* for changes to the scripts and tools
65+
- *Tests* for changes to the bitcoin unit tests or QA tests
66+
- *Trivial* should **only** be used for PRs that do not change generated
67+
executable code. Notably, refactors (change of function arguments and code
68+
reorganization) and changes in behavior should **not** be marked as trivial.
69+
Examples of trivial PRs are changes to:
70+
- comments
71+
- whitespace
72+
- variable names
73+
- logging and messages
74+
- *Utils and libraries* for changes to the utils and libraries
75+
- *Wallet* for changes to the wallet code
76+
77+
Examples:
5778

5879
Consensus: Add new opcode for BIP-XXXX OP_CHECKAWESOMESIG
5980
Net: Automatically create hidden service, listen on Tor

0 commit comments

Comments
 (0)