Repository files navigation

https://bitcoincore.org

For an immediately usable, binary version of the Bitcoin Core software, seehttps://bitcoincore.org/en/download/.

Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fullyvalidate blocks and transactions. It also includes a wallet and graphical userinterface, which can be optionally built.

Further information about Bitcoin Core is available in thedoc folder.

Bitcoin Core is released under the terms of the MIT license. SeeCOPYING for moreinformation or seehttps://opensource.org/licenses/MIT.

Themaster branch is regularly built (seedoc/build-*.md for instructions) and tested, but it is not guaranteed to becompletely stable.Tags are createdregularly from release branches to indicate new official, stable release versions of Bitcoin Core.

Thehttps://github.com/bitcoin-core/gui repository is used exclusively for thedevelopment of the GUI. Its master branch is identical in all monotreerepositories. Release branches and tags do not exist, so please do not forkthat repository unless it is for development reasons.

The contribution workflow is described inCONTRIBUTING.mdand useful hints for developers can be found indoc/developer-notes.md.

Testing and code review is the bottleneck for development; we get more pullrequests than we can review and test on short notice. Please be patient and help out by testingother people's pull requests, and remember this is a security-critical project where any mistake might cost peoplelots of money.

Developers are strongly encouraged to writeunit tests for new code, and tosubmit new unit tests for old code. Unit tests can be compiled and run(assuming they weren't disabled in configure) with:make check. Further details on runningand extending unit tests can be found in/src/test/README.md.

There are alsoregression and integration tests, writtenin Python.These tests can be run (if thetest dependencies are installed) with:test/functional/test_runner.py

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.

Changes should be tested by somebody other than the developer who wrote thecode. This is especially important for large or high-risk changes. It is usefulto add a test plan to the pull request description if testing the changes isnot straightforward.

Changes to translations as well as new translations can be submitted toBitcoin Core's Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See thetranslation process for details on how this works.

Important: We do not accept translation changes as GitHub pull requests because the nextpull from Transifex would automatically overwrite them again.