1Bitcoin Core integration/staging tree
8What is Bitcoin?
11Bitcoin is an experimental new digital currency that enables instant payments to
12anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
13with no central authority: managing transactions and issuing money are carried
14out collectively by the network. Bitcoin Core is the name of open source
15software which enables the use of this currency.
17For more information, as well as an immediately useable, binary version of
18the Bitcoin Core software, see https://www.bitcoin.org/en/download.
23Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
24information or see https://opensource.org/licenses/MIT.
29The `master` branch is regularly built and tested, but is not guaranteed to be
30completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
31regularly to indicate new official, stable release versions of Bitcoin Core.
33The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
35The developer [mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev)
36should be used to discuss complicated or controversial changes before working
37on a patch set.
39Developer IRC can be found on Freenode at #bitcoin-core-dev.
44Testing and code review is the bottleneck for development; we get more pull
45requests than we can review and test on short notice. Please be patient and help out by testing
46other people's pull requests, and remember this is a security-critical project where any mistake might cost people
47lots of money.
49### Automated Testing
51Developers are strongly encouraged to write [unit tests](/doc/unit-tests.md) for new code, and to
52submit new unit tests for old code. Unit tests can be compiled and run
53(assuming they weren't disabled in configure) with: `make check`
55There are also [regression and integration tests](/qa) of the RPC interface, written
56in Python, that are run automatically on the build server.
57These tests can be run with: `qa/pull-tester/rpc-tests.py`
59The Travis CI system makes sure that every pull request is built for Windows
60and Linux, OSX, and that unit and sanity tests are automatically run.
62### Manual Quality Assurance (QA) Testing
64Changes should be tested by somebody other than the developer who wrote the
65code. This is especially important for large or high-risk changes. It is useful
66to add a test plan to the pull request description if testing the changes is
72Changes to translations as well as new translations can be submitted to
73[Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/).
75Translations are periodically pulled from Transifex and merged into the git repository. See the
76[translation process](doc/translation_process.md) for details on how this works.
78**Important**: We do not accept translation changes as GitHub pull requests because the next
79pull from Transifex would automatically overwrite them again.
81Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators).