diff options
| author | John Newbery <john@johnnewbery.com> | 2017-01-13 09:47:21 -0500 |
|---|---|---|
| committer | John Newbery <john@johnnewbery.com> | 2017-01-18 14:04:57 -0500 |
| commit | c70622e942a5da9a7afce32ba71447745ceefa45 (patch) | |
| tree | 47730996a97b3e7536e3385212e4ddeabe36a65b | |
| parent | ed64bcec2dde1f4255f3bd5b0c2f01e4dfe260d3 (diff) | |
Docs: Update CONTRIBUTING.md
Update CONTRIBUTING.md to document the different components.
Notably, trivial should only be used for PRs that do not change the
code.
| -rw-r--r-- | CONTRIBUTING.md | 23 |
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 |