aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2017-01-19 15:12:25 +0100
committerWladimir J. van der Laan <laanwj@gmail.com>2017-01-19 15:20:48 +0100
commite9e7993007a9bd9e16a22e74e422ec30d1b6fbc8 (patch)
tree3b63e428e0b64a1525c67b17e8297a229f537e7a
parent41cb05cc8f3c6b1ec564e24b66fd6c192fe36ed2 (diff)
parentc70622e942a5da9a7afce32ba71447745ceefa45 (diff)
downloadbitcoin-e9e7993007a9bd9e16a22e74e422ec30d1b6fbc8.tar.xz
Merge #9542: Docs: Update CONTRIBUTING.md
c70622e Docs: Update CONTRIBUTING.md (John Newbery)
-rw-r--r--CONTRIBUTING.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 06fcd8dd81..47648cde22 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -53,7 +53,28 @@ about Git.
- Create pull request
The title of the pull request should be prefixed by the component or area that
-the pull request affects. Examples:
+the pull request affects. Valid areas as:
+
+ - *Consensus* for changes to consensus critical code
+ - *Docs* for changes to the documentation
+ - *Qt* for changes to bitcoin-qt
+ - *Mining* for changes to the mining code
+ - *Net* or *P2P* for changes to the peer-to-peer network code
+ - *RPC/REST/ZMQ* for changes to the RPC, REST or ZMQ APIs
+ - *Scripts and tools* for changes to the scripts and tools
+ - *Tests* for changes to the bitcoin unit tests or QA tests
+ - *Trivial* should **only** be used for PRs that do not change generated
+ executable code. Notably, refactors (change of function arguments and code
+ reorganization) and changes in behavior should **not** be marked as trivial.
+ Examples of trivial PRs are changes to:
+ - comments
+ - whitespace
+ - variable names
+ - logging and messages
+ - *Utils and libraries* for changes to the utils and libraries
+ - *Wallet* for changes to the wallet code
+
+Examples:
Consensus: Add new opcode for BIP-XXXX OP_CHECKAWESOMESIG
Net: Automatically create hidden service, listen on Tor