Bitcoin Core integration/staging tree
Clone or download
Pull request Compare This branch is 74 commits behind bitcoin:master.
MarcoFalke Merge bitcoin#15127: docs: Clarifying testing instructions
ef5ebc6 docs: Clarifying testing instructions (benthecarman)

Pull request description:

  This statement confused me on my first time reading through.  Hopefully, this addition will help someone else on their first time.

Tree-SHA512: 17f421275adb7586eca954910269d29fcd3bacc42fab4bc2e01110f9e13ca6f8c1ca178246f7192e1131f14ced7f7dc0b57e7aec324898807c1813a2ebc513de
Latest commit 5da08e0 Jan 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Get more info about GUI-related issue on Linux Dec 27, 2018
.travis If tests are ran with (ASan + LSan), Docker needs access to ptrace Dec 28, 2018
.tx tx: Update transifex slug 016x→017x Aug 2, 2018
build-aux/m4 Bump the minimum Qt version to 5.2 Nov 13, 2018
build_msvc Fix the build problem in libbitcoin_server Jan 5, 2019
contrib Merge bitcoin#15054: Update copyright headers to 2018 Dec 31, 2018
depends Merge bitcoin#13884: depends: Enable bdb unicode support for Windows Jan 3, 2019
doc Fix download link Jan 8, 2019
share Merge bitcoin#14701: build: Add CLIENT_VERSION_BUILD to CFBundleGetIn… Dec 12, 2018
src Merge bitcoin#14517: qt: Fix start with the `-min` option Jan 9, 2019
test Merge bitcoin#15127: docs: Clarifying testing instructions Jan 9, 2019
.appveyor.yml appveyor: Script improvement part II Nov 6, 2018
.gitattributes Separate protocol versioning from clientversion Oct 29, 2014
.gitignore gitignore contents of db4 folder Oct 19, 2018
.python-version [test] Travis: enforce Python 3.4 support in functional tests Dec 12, 2018
.travis.yml Merge bitcoin#15020: Build: add names to Travis jobs Jan 3, 2019
CONTRIBUTING.md Botbot.me (IRC logs) not available anymore Jan 1, 2019
COPYING [Trivial] Update license year range to 2019 Dec 31, 2018
INSTALL.md Update INSTALL landing redirection notice for build instructions. Oct 5, 2016
Makefile.am build: Add bitcoin-tx.exe into Windows installer Nov 9, 2018
README.md [doc] conf: Remove deprecated options from docs, Other cleanup Nov 7, 2018
autogen.sh Add "export LC_ALL=C" to all shell scripts Jun 14, 2018
configure.ac [Trivial] Update license year range to 2019 Dec 31, 2018
libbitcoinconsensus.pc.in Unify package name to as few places as possible without major changes Dec 14, 2015

README.md

Bitcoin Core integration/staging tree

Build Status

https://bitcoincore.org

What is Bitcoin?

Bitcoin is an experimental 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://bitcoincore.org/en/download/, or read the original whitepaper.

License

Bitcoin Core is released under the terms of the MIT license. See 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 are created regularly to indicate new official, stable release versions of Bitcoin Core.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.

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 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. Further details on running and extending unit tests can be found in /src/test/README.md.

There are also regression and integration tests, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.

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.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process 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.