mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 18:09:47 +01:00

Bitcoin Core integration/staging tree

bitcoin c-plus-plus cryptocurrency cryptography p2p

Go to file

Cory Fields 6986861fda build: use -mwindows for gui targets when linking with mingw		2014-01-27 15:30:51 -05:00
contrib	gitian: Windows 64 bit support	2014-01-21 14:02:13 +01:00
doc	Merge pull request #3560	2014-01-23 08:26:11 +01:00
qa	qt5: fix --with-qt with no arguments	2014-01-10 16:30:33 -05:00
share	build: Change package name to Bitcoin Core	2014-01-21 19:58:10 +01:00
src	build: use -mwindows for gui targets when linking with mingw	2014-01-27 15:30:51 -05:00
.gitattributes	Build identification strings	2012-04-10 18:16:53 +02:00
.gitignore	src/leveldb/Makefile is ignored?	2014-01-13 18:37:57 +08:00
autogen.sh	autogen.sh: Stop passing --verbose to autoreconf	2013-11-27 17:29:00 -08:00
configure.ac	Typesafe strprintf/error/LogPrint functions	2014-01-23 16:05:00 +01:00
COPYING	Bump version numbers for 0.8 release	2013-01-30 14:19:09 -05:00
INSTALL	Prettify some /Contrib READMEs	2013-10-21 20:07:31 -04:00
Makefile.am	build: Package docs/ and don't package source.	2014-01-21 18:29:04 +01:00
pkg.m4	autotools: switch to autotools buildsystem	2013-09-05 21:31:03 -04:00
README.md	Fix heading in README.md	2013-12-17 11:51:49 +01:00

README.md

Bitcoin Core integration/staging tree

http://www.bitcoin.org

What is Bitcoin?

Bitcoin is an experimental new 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 http://www.bitcoin.org/en/download.

License

Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see http://opensource.org/licenses/MIT.

Development process

Developers work in their own trees, then submit pull requests when they think their feature or bug fix is ready.

If it is a simple/trivial/non-controversial change, then one of the Bitcoin development team members simply pulls it.

If it is a more complicated or potentially controversial change, then the patch submitter will be asked to start a discussion (if they haven't already) on the mailing list.

The patch will be accepted if there is broad consensus that it is a good thing. Developers should expect to rework and resubmit patches if the code doesn't match the project's coding conventions (see doc/coding.md) or are controversial.

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.

Testing

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test. Please be patient and help out, 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

Every pull request is built for both Windows and Linux on a dedicated server, and unit and sanity tests are automatically run. The binaries produced may be used for manual QA testing — a link to them will appear in a comment on the pull request posted by BitcoinPullTester. See https://github.com/TheBlueMatt/test-scripts for the build/test scripts.

Manual Quality Assurance (QA) Testing

Large changes should have a test plan, and should be tested by somebody other than the developer who wrote the code. See https://github.com/bitcoin/QA/ for how to create a test plan.