lbrycrd/README.md

67 lines
2.2 KiB
Markdown
Raw Normal View History

2011-09-06 05:02:35 +02:00
2010-12-19 16:39:36 +01:00
Bitcoin integration/staging tree
2010-09-23 20:06:50 +02:00
Development process
===================
2010-09-23 20:06:50 +02:00
2011-09-06 05:02:35 +02:00
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:
http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development
2010-12-19 16:39:36 +01:00
2011-09-06 05:02:35 +02:00
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 they don't match the project's coding conventions (see coding.txt)
or are controversial.
2010-12-19 16:39:36 +01:00
2011-09-06 05:02:35 +02:00
The master branch is regularly built and tested, but is not guaranteed
to be completely stable. Tags are regularly created to indicate new
official, stable release versions of Bitcoin.
2010-12-19 16:39:36 +01:00
Testing
=======
2011-09-27 04:22:19 +02:00
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.
2011-09-27 04:22:19 +02:00
Automated Testing
-----------------
2011-09-27 04:22:19 +02:00
Developers are strongly encouraged to write unit tests for new code,
and to submit new unit tests for old code.
Unit tests for the core code are in src/test/
To compile and run them:
cd src; make -f makefile.linux test
Unit tests for the GUI code are in src/qt/test/
To compile and run them:
qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
make -f Makefile.test
./Bitcoin-Qt
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
from '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.