README.md

   1 Bitcoin Core integration/staging tree
   2 =====================================
   3
   4 https://www.bitcoin.org
   5
   6 Copyright (c) 2009-2014 Bitcoin Core Developers
   7
   8 What is Bitcoin?
   9 ----------------
  10
  11 Bitcoin is an experimental new digital currency that enables instant payments to
  12 anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
  13 with no central authority: managing transactions and issuing money are carried
  14 out collectively by the network. Bitcoin Core is the name of open source
  15 software which enables the use of this currency.
  16
  17 For more information, as well as an immediately useable, binary version of
  18 the Bitcoin Core software, see https://www.bitcoin.org/en/download.
  19
  20 License
  21 -------
  22
  23 Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
  24 information or see http://opensource.org/licenses/MIT.
  25
  26 Development process
  27 -------------------
  28
  29 Developers work in their own trees, then submit pull requests when they think
  30 their feature or bug fix is ready.
  31
  32 If it is a simple/trivial/non-controversial change, then one of the Bitcoin
  33 development team members simply pulls it.
  34
  35 If it is a *more complicated or potentially controversial* change, then the patch
  36 submitter will be asked to start a discussion (if they haven't already) on the
  37 [mailing list](http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development).
  38
  39 The patch will be accepted if there is broad consensus that it is a good thing.
  40 Developers should expect to rework and resubmit patches if the code doesn't
  41 match the project's coding conventions (see [doc/coding.md](doc/coding.md)) or are
  42 controversial.
  43
  44 The `master` branch is regularly built and tested, but is not guaranteed to be
  45 completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
  46 regularly to indicate new official, stable release versions of Bitcoin.
  47
  48 Testing
  49 -------
  50
  51 Testing and code review is the bottleneck for development; we get more pull
  52 requests than we can review and test on short notice. Please be patient and help out by testing
  53 other people's pull requests, and remember this is a security-critical project where any mistake might cost people
  54 lots of money.
  55
  56 ### Automated Testing
  57
  58 Developers are strongly encouraged to write unit tests for new code, and to
  59 submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: `make check`
  60
  61 Every pull request is built for both Windows and Linux on a dedicated server,
  62 and unit and sanity tests are automatically run. The binaries produced may be
  63 used for manual QA testing — a link to them will appear in a comment on the
  64 pull request posted by [BitcoinPullTester](https://github.com/BitcoinPullTester). See https://github.com/TheBlueMatt/test-scripts
  65 for the build/test scripts.
  66
  67 ### Manual Quality Assurance (QA) Testing
  68
  69 Large changes should have a test plan, and should be tested by somebody other
  70 than the developer who wrote the code.
  71 See https://github.com/bitcoin/QA/ for how to create a test plan.
  72
  73 Translations
  74 ------------
  75
  76 Changes to translations as well as new translations can be submitted to
  77 [Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/).
  78
  79 Translations are periodically pulled from Transifex and merged into the git repository. See the
  80 [translation process](doc/translation_process.md) for details on how this works.
  81
  82 **Important**: We do not accept translation changes as GitHub pull requests because the next
  83 pull from Transifex would automatically overwrite them again.
  84
  85 Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators).
  86
  87 Development tips and tricks
  88 ---------------------------
  89
  90 **compiling for debugging**
  91
  92 Run configure with the --enable-debug option, then make. Or run configure with
  93 CXXFLAGS="-g -ggdb -O0" or whatever debug flags you need.
  94
  95 **debug.log**
  96
  97 If the code is behaving strangely, take a look in the debug.log file in the data directory;
  98 error and debugging message are written there.
  99
 100 The -debug=... command-line option controls debugging; running with just -debug will turn
 101 on all categories (and give you a very large debug.log file).
 102
 103 The Qt code routes qDebug() output to debug.log under category "qt": run with -debug=qt
 104 to see it.
 105
 106 **testnet and regtest modes**
 107
 108 Run with the -testnet option to run with "play bitcoins" on the test network, if you
 109 are testing multi-machine code that needs to operate across the internet.
 110
 111 If you are testing something that can run on one machine, run with the -regtest option.
 112 In regression test mode blocks can be created on-demand; see qa/rpc-tests/ for tests
 113 that run in -regest mode.
 114
 115 **DEBUG_LOCKORDER**
 116
 117 Bitcoin Core is a multithreaded application, and deadlocks or other multithreading bugs
 118 can be very difficult to track down. Compiling with -DDEBUG_LOCKORDER (configure
 119 CXXFLAGS="-DDEBUG_LOCKORDER -g") inserts run-time checks to keep track of what locks
 120 are held, and adds warning to the debug.log file if inconsistencies are detected.