OctoinCoin
Switch branches/tags
Nothing to show
Clone or download

README.md

OCC Core integration/staging tree

What is OctoinCoin?

OctoinCoin is an experimental digital currency that enables instant payments to anyone, anywhere in the world. OctoinCoin uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. OCC Core is the name of open source software which enables the use of this currency.

License

OCC Core is released under the terms of the MIT license. See 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.

The contribution workflow is described in CONTRIBUTING.md.

Developer IRC can be found on Freenode at #OctoinCoin-core-dev.

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 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 of the RPC interface, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: qa/pull-tester/rpc-tests.py

The Travis CI system makes sure that every pull request is built for Windows, Linux, and OS X, and that unit/sanity tests are run automatically.

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.