mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 18:09:47 +01:00
Code Issues Projects Releases Wiki Activity
Bitcoin Core integration/staging tree
17,888 Commits 6 Branches 318 Tags 3.2 GiB
C++ 64%
Python 19.9%
C 12.4%
CMake 1.1%
Shell 0.9%
Other 1.6%
8c3c402a5a
Go to file
Wladimir J. van der Laan 8c3c402a5a
Merge #13717: docs: Link to python style guidelines from developer notes 
a9e898a4ad docs: Link to python style guidelines from developer notes (Mason Simon)

Pull request description:

  Initially I moved the python style guidelines from the functional test README, but some of the python rules are test-specific, and most of the developer notes doc is C++ centric, so just dropping a link seemed better.

Tree-SHA512: 9d4d5cc45526319a118595d90fcfad2c9aced22007aa096d8af04ba1b963312822804f4c15b0b227d66af49565034437691b7760e7ff6d1e3f8b10b898906362
2018-08-07 13:56:31 +02:00
.github Make default issue text all comments to make issues more readable 2017-11-16 11:50:56 -05:00
.tx tx: Update transifex slug 016x→017x 2018-08-02 13:42:15 +02:00
build-aux/m4 Merge #13095: build: update ax_boost_chrono/unit_test_framework 2018-07-26 08:54:59 -04:00
contrib Merge #13809: contrib: Remove debian and rpm subfolder 2018-07-31 11:56:09 -04:00
depends Add aarch64 qt depends support for cross compiling bitcoin-qt 2018-07-29 15:59:55 +02:00
doc Merge #13717: docs: Link to python style guidelines from developer notes 2018-08-07 13:56:31 +02:00
share contrib: Remove debian and rpm subfolders 2018-07-30 14:00:56 -04:00
src Merge #13667: wallet: Fix backupwallet for multiwallets 2018-08-07 13:31:54 +02:00
test Merge #13667: wallet: Fix backupwallet for multiwallets 2018-08-07 13:31:54 +02:00
.gitattributes
.gitignore [build] .gitignore: add QT Creator artifacts 2017-12-22 12:37:00 +01:00
.travis.yml qa: Create unicode tempdir in test_runner 2018-08-03 11:29:02 -04:00
autogen.sh Add "export LC_ALL=C" to all shell scripts 2018-06-14 15:27:52 +02:00
configure.ac Merge #13482: Remove boost::program_options dependency 2018-07-20 16:45:44 +02:00
CONTRIBUTING.md doc: add note to contributor docs about warranted PR's 2018-07-30 23:47:46 +09:00
COPYING [Trivial] Update license year range to 2018 2018-01-01 04:33:09 +09:00
INSTALL.md Update INSTALL landing redirection notice for build instructions. 2016-10-06 12:27:23 +13:00
libbitcoinconsensus.pc.in
Makefile.am contrib: Remove debian and rpm subfolders 2018-07-30 14:00:56 -04:00
README.md doc: Adjust bitcoincore.org links 2018-07-22 10:32:38 -04:00

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.

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.