Files
blackcoin-more/README.md
2018-10-01 19:53:46 +03:00

60 lines
2.5 KiB
Markdown

Blackcoin More
=====================================
https://blackcoin.org
What is Blackcoin?
----------------
Blackcoin is a decentralised digital currency with near-instant transaction speeds and negligible transaction fees built upon Proof of Stake 3.0 as
introduced by the Blackcoin development team.
Blackcoin More is the name of open source software which enables the use of this currency. It takes Blackcoin to the next level by building upon
Bitcoin Core 0.12.1 with some patches from newer Bitcoin Core versions to offer performance enhancements, wider compatibility with third party services and a more advanced base.
For more information, as well as an immediately useable, binary version of the Blackcoin More software, see https://blackcoin.org.
License
-------
Blackcoin More is released under the terms of the MIT license. See [COPYING](COPYING) for more
information or see https://opensource.org/licenses/MIT.
Development Process
-------------------
The `master` branch is regularly built and tested, but is not guaranteed to be
completely stable. [Tags](https://gitlab.com/blackcoin/blackcoin-more/tags) are created
regularly to indicate new official, stable release versions of Blackcoin More.
Change log can be found in [CHANGELOG.md](CHANGELOG.md).
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
The best place to get started is to join the Development channel on Gitter: https://gitter.im/Blackcoin_Hub/Development
Testing
-------
Testing and code review is the bottleneck for development; we get more pull
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
lots of money.
### Automated Testing
Developers are strongly encouraged to write [unit tests](/doc/unit-tests.md) for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled in configure) with: `make check`
There are also [regression and integration tests](/qa) of the RPC interface, written
in Python, that are run automatically on the build server.
These tests can be run with: `qa/pull-tester/rpc-tests.py`
### Manual Quality Assurance (QA) Testing
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.