2018-01-16 16:35:36 +01:00
|
|
|
# LBRYcrd - The LBRY blockchain
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2014-08-26 11:10:52 +02:00
|
|
|
|
2018-01-16 16:35:36 +01:00
|
|
|
## What is LBRYcrd?
|
2016-01-30 20:30:13 +01:00
|
|
|
|
2018-01-16 16:35:36 +01:00
|
|
|
LBRYcrd uses a blockchain similar to bitcoin's to implement an index and payment system for content on the LBRY network. It is a fork of bitcoin core.
|
2016-01-30 20:30:13 +01:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2018-01-16 16:35:36 +01:00
|
|
|
## Development Process
|
2010-09-23 20:06:50 +02:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
The `master` branch is regularly built and tested, but is not guaranteed to be
|
2018-01-16 16:35:36 +01:00
|
|
|
completely stable. [Releases](https://github.com/lbryio/lbrycrd/releases) are created
|
|
|
|
regularly to indicate new official, stable release versions.
|
2010-12-19 16:39:36 +01:00
|
|
|
|
2015-09-24 15:28:07 +02:00
|
|
|
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
|
|
|
|
|
2018-01-16 16:35:36 +01:00
|
|
|
## Testing
|
2012-12-13 03:27:58 +01:00
|
|
|
|
|
|
|
Testing and code review is the bottleneck for development; we get more pull
|
2014-05-23 09:49:01 +02:00
|
|
|
requests than we can review and test on short notice. Please be patient and help out by testing
|
|
|
|
other people's pull requests, and remember this is a security-critical project where any mistake might cost people
|
2012-12-13 03:27:58 +01:00
|
|
|
lots of money.
|
|
|
|
|
|
|
|
### Automated Testing
|
2011-09-27 04:22:19 +02:00
|
|
|
|
2015-11-23 21:11:53 +01:00
|
|
|
Developers are strongly encouraged to write [unit tests](/doc/unit-tests.md) for new code, and to
|
2015-11-18 00:26:07 +01:00
|
|
|
submit new unit tests for old code. Unit tests can be compiled and run
|
|
|
|
(assuming they weren't disabled in configure) with: `make check`
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2015-11-18 00:26:07 +01:00
|
|
|
There are also [regression and integration tests](/qa) of the RPC interface, written
|
2015-06-30 15:40:44 +02:00
|
|
|
in Python, that are run automatically on the build server.
|
2016-03-10 12:12:40 +01:00
|
|
|
These tests can be run (if the [test dependencies](/qa) are installed) with: `qa/pull-tester/rpc-tests.py`
|
2015-06-30 15:40:44 +02:00
|
|
|
|
2015-11-12 13:07:34 +01:00
|
|
|
The Travis CI system makes sure that every pull request is built for Windows
|
2016-03-10 12:12:40 +01:00
|
|
|
and Linux, OS X, and that unit and sanity tests are automatically run.
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
### Manual Quality Assurance (QA) Testing
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2015-11-12 13:07:34 +01:00
|
|
|
Changes should be tested by somebody other than the developer who wrote the
|
|
|
|
code. This is especially important for large or high-risk changes. It is useful
|
|
|
|
to add a test plan to the pull request description if testing the changes is
|
|
|
|
not straightforward.
|
2014-04-09 20:11:08 +02:00
|
|
|
|
|
|
|
|
2018-01-16 16:35:36 +01:00
|
|
|
## License
|
2014-05-23 16:30:38 +02:00
|
|
|
|
2018-01-16 16:35:36 +01:00
|
|
|
MIT
|