mirror of
https://github.com/dashpay/dash.git
synced 2024-12-29 05:49:11 +01:00
2ab835ae6c
If ZMQ is enabled, check whether it's installed before running ZMQ tests. If it isn't, disable ZMQ and print a warning. Also add dependency info to test docs, so users know ZMQ is required before running tests, and so they know how to install it. When following the build instructions before this change then trying to run the RPC tests, a unix user would get an error when python tried to import zmq. There may be other dependencies that should be added to the docs, particularly ones for non-unix systems. This is the only unlisted dependency I encountered using linux.
83 lines
3.4 KiB
Markdown
83 lines
3.4 KiB
Markdown
Bitcoin Core integration/staging tree
|
|
=====================================
|
|
|
|
[](https://travis-ci.org/bitcoin/bitcoin)
|
|
|
|
https://bitcoincore.org
|
|
|
|
What is Bitcoin?
|
|
----------------
|
|
|
|
Bitcoin is an experimental new digital currency that enables instant payments to
|
|
anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
|
|
with no central authority: managing transactions and issuing money are carried
|
|
out collectively by the network. Bitcoin Core is the name of open source
|
|
software which enables the use of this currency.
|
|
|
|
For more information, as well as an immediately useable, binary version of
|
|
the Bitcoin Core software, see https://bitcoin.org/en/download, or read the
|
|
[original whitepaper](https://bitcoincore.org/bitcoin.pdf).
|
|
|
|
License
|
|
-------
|
|
|
|
Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
|
|
information or see https://opensource.org/licenses/MIT.
|
|
|
|
Development Process
|
|
-------------------
|
|
|
|
The `master` branch is regularly built and tested, but is not guaranteed to be
|
|
completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
|
|
regularly to indicate new official, stable release versions of Bitcoin Core.
|
|
|
|
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
The developer [mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev)
|
|
should be used to discuss complicated or controversial changes before working
|
|
on a patch set.
|
|
|
|
Developer IRC can be found on Freenode at #bitcoin-core-dev.
|
|
|
|
Testing
|
|
-------
|
|
|
|
Testing and code review is the bottleneck for development; we get more pull
|
|
requests than we can review and test on short notice. Please be patient and help out by testing
|
|
other people's pull requests, and remember this is a security-critical project where any mistake might cost people
|
|
lots of money.
|
|
|
|
### Automated Testing
|
|
|
|
Developers are strongly encouraged to write [unit tests](/doc/unit-tests.md) for new code, and to
|
|
submit new unit tests for old code. Unit tests can be compiled and run
|
|
(assuming they weren't disabled in configure) with: `make check`
|
|
|
|
There are also [regression and integration tests](/qa) of the RPC interface, written
|
|
in Python, that are run automatically on the build server.
|
|
These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py`
|
|
|
|
The Travis CI system makes sure that every pull request is built for Windows
|
|
and Linux, OS X, and that unit and sanity tests are automatically run.
|
|
|
|
### Manual Quality Assurance (QA) Testing
|
|
|
|
Changes should be tested by somebody other than the developer who wrote the
|
|
code. This is especially important for large or high-risk changes. It is useful
|
|
to add a test plan to the pull request description if testing the changes is
|
|
not straightforward.
|
|
|
|
Translations
|
|
------------
|
|
|
|
Changes to translations as well as new translations can be submitted to
|
|
[Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/).
|
|
|
|
Translations are periodically pulled from Transifex and merged into the git repository. See the
|
|
[translation process](doc/translation_process.md) for details on how this works.
|
|
|
|
**Important**: We do not accept translation changes as GitHub pull requests because the next
|
|
pull from Transifex would automatically overwrite them again.
|
|
|
|
Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators).
|