The blockchain that provides the digital content namespace for the LBRY protocol
Find a file
Wladimir J. van der Laan bd62f8d6ee
Merge #16645: doc: initial RapidCheck property-based testing documentation
8616c81f08 doc: initial RapidCheck property-based testing documentation (Jon Atack)

Pull request description:

  This commit proposes documentation that would have been helpful to me when setting up RapidCheck to work correctly with Bitcoin Core. I tested these instructions repeatedly with Linux (Debian 4.19 / GCC 8.3) and macOS (10.14.6 / AppleClang 10).

  The markdown version can be seen at https://github.com/jonatack/bitcoin/blob/rapidcheck-documentation/doc/rapidcheck.md.

ACKs for top commit:
  fanquake:
    ACK 8616c81f08 - Thanks for updating.

Tree-SHA512: 9c2a65f0eb99f59e9adfea82855f217727a8a9d30618c1c0bdd2a73ae9c1ee61bc7efd59fc8703a666d182ad4220e22d6034ac3109311e6573dad00dfa4b06ea
2019-08-19 16:08:53 +02:00
.github Get more info about GUI-related issue on Linux 2018-12-27 06:53:07 +02:00
.tx qt: Pre-0.18 split-off translations update 2019-02-04 15:24:37 +01:00
build-aux/m4 doc: fix typo in bitcoin_qt.m4 comment 2019-07-24 09:17:47 +08:00
build_msvc qt: Remove menu icons 2019-08-15 13:05:10 +02:00
ci Merge #16623: ci: Add environment files for all settings 2019-08-19 09:39:53 -04:00
contrib scripts: remove github-merge.py 2019-08-19 19:16:57 +08:00
depends build: disable libxcb extensions 2019-08-06 16:53:36 +08:00
doc Merge #16645: doc: initial RapidCheck property-based testing documentation 2019-08-19 16:08:53 +02:00
share doc: Refer in rpcbind doc to the manpage 2019-08-16 10:51:59 -04:00
src Merge #15864: Fix datadir handling 2019-08-19 10:01:30 -04:00
test Merge #15864: Fix datadir handling 2019-08-19 10:01:30 -04:00
.appveyor.yml Changes the verbosity of msbuild from quiet to normal in the appveyor script. Increasing the verbosity helps to identify the cause of build errors which is the main purpose of the appveyor script. 2019-07-31 10:00:02 +02:00
.cirrus.yml ci: Use ./ci/ on non-travis host 2019-08-15 11:13:09 -04:00
.gitattributes Separate protocol versioning from clientversion 2014-10-29 00:24:40 -04:00
.gitignore [build] .gitignore add Qt Creator Makefile.am.user 2019-08-02 10:11:24 +01:00
.python-version .python-version: Specify full version 3.5.6 2019-03-02 12:06:26 -05:00
.style.yapf test: .style.yapf: Set column_limit=160 2019-03-04 18:28:13 -05:00
.travis.yml Merge #16623: ci: Add environment files for all settings 2019-08-19 09:39:53 -04:00
autogen.sh Enable ShellCheck rules 2019-07-04 19:35:25 +03:00
configure.ac build: echo prop tests status during build 2019-08-16 11:51:07 +02:00
CONTRIBUTING.md doc: update labels in CONTRIBUTING.md 2019-07-29 13:17:05 -04:00
COPYING [Trivial] Update license year range to 2019 2018-12-31 04:27:59 +01:00
INSTALL.md Update INSTALL landing redirection notice for build instructions. 2016-10-06 12:27:23 +13:00
libbitcoinconsensus.pc.in Unify package name to as few places as possible without major changes 2015-12-14 02:11:10 +00:00
Makefile.am Failing functional tests stop lcov 2019-06-13 11:39:15 -04:00
README.md doc: Remove travis badge from readme 2019-06-19 11:39:27 -04:00
SECURITY.md doc: Remove explicit mention of version from SECURITY.md 2019-06-14 06:39:17 -04:00

Bitcoin Core integration/staging tree

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.