README.md

   1 Bitcoin integration/staging tree
   2 ================================
   3
   4 http://www.bitcoin.org
   5
   6 Copyright (c) 2009-2013 Bitcoin 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 is also the name of the 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 client sofware, see http://www.bitcoin.org.
  19
  20 License
  21 -------
  22
  23 Bitcoin is released under the terms of the MIT license. See `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.txt`) 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. Please be patient and help out, and
  53 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.
  60
  61 Unit tests for the core code are in `src/test/`. To compile and run them:
  62
  63     cd src; make -f makefile.unix test
  64
  65 Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
  66
  67     qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
  68     make -f Makefile.test
  69     ./bitcoin-qt_test
  70
  71 Every pull request is built for both Windows and Linux on a dedicated server,
  72 and unit and sanity tests are automatically run. The binaries produced may be
  73 used for manual QA testing -- a link to them will appear in a comment on the
  74 pull request posted by 'BitcoinPullTester'. See `https://github.com/TheBlueMatt/test-scripts`
  75 for the build/test scripts.
  76
  77 ### Manual Quality Assurance (QA) Testing
  78
  79 Large changes should have a test plan, and should be tested by somebody other
  80 than the developer who wrote the code.
  81
  82 See `https://github.com/bitcoin/QA/` for how to create a test plan.