BurritoCoin is an experimental digital currency that enables instant payments to anyone, anywhere in the world. BurritoCoin uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. BurritoCoin Core is the name of open source software which enables the use of this currency.
For more information, as well as an immediately useable, binary version of the BurritoCoin Core software, see https://burritoco.in.
BurritoCoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.
The master branch is regularly built (see doc/build-*.md for instructions) and tested, but it is not guaranteed to be
completely stable. Tags are created
regularly from release branches to indicate new official, stable release versions of BurritoCoin Core.
The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.
For now, complicated or controversial changes should be discussed in a GitHub issue at https://github.com/BurritoCoinDev/BurritoCoin/issues before a patch set is opened. A dedicated mailing list / chat channel will be announced once the project has the contributor base to justify them.
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.
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. Further details on running
and extending unit tests can be found in /src/test/README.md.
There are also regression and integration tests, written
in Python, that can be run (if the test dependencies are installed)
with: test/functional/test_runner.py. Note: a burritocoin_scrypt Python
extension module is required to run the full functional suite; see
/test/README.md for build instructions when that lands.
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.
We only accept translation fixes that are submitted through BurritoCoin Core's Transifex page. Translations are converted to BurritoCoin periodically.
Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.
Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.