README.md

   1
   2 Bitcoin integration/staging tree
   3
   4 Development process
   5 ===================
   6
   7 Developers work in their own trees, then submit pull requests when
   8 they think their feature or bug fix is ready.
   9
  10 If it is a simple/trivial/non-controversial change, then one of the
  11 bitcoin development team members simply pulls it.
  12
  13 If it is a more complicated or potentially controversial
  14 change, then the patch submitter will be asked to start a
  15 discussion (if they haven't already) on the mailing list:
  16 http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development
  17
  18 The patch will be accepted if there is broad consensus that it is a
  19 good thing.  Developers should expect to rework and resubmit patches
  20 if they don't match the project's coding conventions (see coding.txt)
  21 or are controversial.
  22
  23 The master branch is regularly built and tested, but is not guaranteed
  24 to be completely stable. Tags are regularly created to indicate new
  25 official, stable release versions of Bitcoin.
  26
  27 Testing
  28 =======
  29
  30 Testing and code review is the bottleneck for development; we get more
  31 pull requests than we can review and test. Please be patient and help
  32 out, and remember this is a security-critical project where any
  33 mistake might cost people lots of money.
  34
  35 Automated Testing
  36 -----------------
  37
  38 Developers are strongly encouraged to write unit tests for new code,
  39 and to submit new unit tests for old code.
  40
  41 Unit tests for the core code are in src/test/
  42 To compile and run them:
  43   cd src; make -f makefile.linux test
  44
  45 Unit tests for the GUI code are in src/qt/test/
  46 To compile and run them:
  47   qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
  48   make -f Makefile.test
  49   ./Bitcoin-Qt
  50
  51 Every pull request is built for both Windows and
  52 Linux on a dedicated server, and unit and sanity
  53 tests are automatically run. The binaries
  54 produced may be used for manual QA testing
  55 (a link to them will appear in a comment on the pull request
  56 from 'BitcoinPullTester').
  57 See https://github.com/TheBlueMatt/test-scripts for the
  58 build/test scripts.
  59
  60 Manual Quality Assurance (QA) Testing
  61 -------------------------------------
  62
  63 Large changes should have a test plan, and should be tested
  64 by somebody other than the developer who wrote the code.
  65
  66 See https://github.com/bitcoin/QA/ for how to create a test plan.