2015-10-05 21:20:43 +02:00
|
|
|
Bitcoin Core integration/staging tree
|
2013-12-17 11:50:26 +01:00
|
|
|
=====================================
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2016-01-15 08:45:39 +01:00
|
|
|
https://bitcoincore.org
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2021-02-17 09:19:26 +01:00
|
|
|
For an immediately usable, binary version of the Bitcoin Core software, see
|
|
|
|
|
https://bitcoincore.org/en/download/.
|
|
|
|
|
|
2022-05-09 14:55:39 +02:00
|
|
|
What is Bitcoin Core?
|
|
|
|
|
---------------------
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2022-05-09 14:55:39 +02:00
|
|
|
Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully
|
|
|
|
|
validate blocks and transactions. It also includes a wallet and graphical user
|
|
|
|
|
interface, which can be optionally built.
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2022-05-09 14:55:39 +02:00
|
|
|
Further information about Bitcoin Core is available in the [doc folder](/doc).
|
2012-12-13 03:27:58 +01:00
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
2013-12-17 08:47:30 +01:00
|
|
|
Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
|
2015-12-10 18:45:23 +01:00
|
|
|
information or see https://opensource.org/licenses/MIT.
|
2010-09-23 20:06:50 +02:00
|
|
|
|
2015-09-24 15:28:07 +02:00
|
|
|
Development Process
|
2012-12-13 03:27:58 +01:00
|
|
|
-------------------
|
2010-09-23 20:06:50 +02:00
|
|
|
|
2020-05-24 21:00:07 +02:00
|
|
|
The `master` branch is regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to be
|
2012-12-13 03:27:58 +01:00
|
|
|
completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
|
2020-05-24 21:00:07 +02:00
|
|
|
regularly from release branches to indicate new official, stable release versions of Bitcoin Core.
|
|
|
|
|
|
|
|
|
|
The https://github.com/bitcoin-core/gui repository is used exclusively for the
|
|
|
|
|
development of the GUI. Its master branch is identical in all monotree
|
|
|
|
|
repositories. Release branches and tags do not exist, so please do not fork
|
|
|
|
|
that repository unless it is for development reasons.
|
2010-12-19 16:39:36 +01:00
|
|
|
|
2016-06-29 13:13:00 +02:00
|
|
|
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
|
and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md).
|
2015-09-24 15:28:07 +02:00
|
|
|
|
2013-01-09 21:55:47 +01:00
|
|
|
Testing
|
2012-12-13 03:27:58 +01:00
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Testing and code review is the bottleneck for development; we get more pull
|
2014-05-23 09:49:01 +02:00
|
|
|
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
|
2012-12-13 03:27:58 +01:00
|
|
|
lots of money.
|
|
|
|
|
|
|
|
|
|
### Automated Testing
|
2011-09-27 04:22:19 +02:00
|
|
|
|
2016-11-02 18:16:32 +01:00
|
|
|
Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to
|
2015-11-18 00:26:07 +01:00
|
|
|
submit new unit tests for old code. Unit tests can be compiled and run
|
2016-11-02 18:16:32 +01:00
|
|
|
(assuming they weren't disabled in configure) with: `make check`. Further details on running
|
|
|
|
|
and extending unit tests can be found in [/src/test/README.md](/src/test/README.md).
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2017-03-09 15:44:57 +01:00
|
|
|
There are also [regression and integration tests](/test), written
|
2021-02-17 09:19:26 +01:00
|
|
|
in Python.
|
2017-03-09 15:53:26 +01:00
|
|
|
These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py`
|
2015-06-30 15:40:44 +02:00
|
|
|
|
2020-12-17 09:54:37 +01:00
|
|
|
The CI (Continuous Integration) systems make sure that every pull request is built for Windows, Linux, and macOS,
|
|
|
|
|
and that unit/sanity tests are run automatically.
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
### Manual Quality Assurance (QA) Testing
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2015-11-12 13:07:34 +01:00
|
|
|
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.
|
2014-04-09 20:11:08 +02:00
|
|
|
|
|
|
|
|
Translations
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Changes to translations as well as new translations can be submitted to
|
2019-02-14 11:48:53 +01:00
|
|
|
[Bitcoin Core's Transifex page](https://www.transifex.com/bitcoin/bitcoin/).
|
2014-04-09 20:11:08 +02:00
|
|
|
|
2014-07-07 10:32:38 +02:00
|
|
|
Translations are periodically pulled from Transifex and merged into the git repository. See the
|
2014-04-09 20:11:08 +02:00
|
|
|
[translation process](doc/translation_process.md) for details on how this works.
|
|
|
|
|
|
2014-07-07 10:32:38 +02:00
|
|
|
**Important**: We do not accept translation changes as GitHub pull requests because the next
|
2014-04-09 20:11:08 +02:00
|
|
|
pull from Transifex would automatically overwrite them again.
|
