2018-06-12 21:10:36 +02:00
|
|
|
Dash Core staging tree 0.12.3
|
2014-12-12 13:05:25 +01:00
|
|
|
===============================
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2017-12-01 06:13:49 +01:00
|
|
|
`master:` [![Build Status](https://travis-ci.org/dashpay/dash.svg?branch=master)](https://travis-ci.org/dashpay/dash) `develop:` [![Build Status](https://travis-ci.org/dashpay/dash.svg?branch=develop)](https://travis-ci.org/dashpay/dash/branches)
|
2016-05-30 08:22:30 +02:00
|
|
|
|
2016-01-31 14:11:16 +01:00
|
|
|
https://www.dash.org
|
2012-12-13 03:27:58 +01:00
|
|
|
|
2014-12-12 12:09:19 +01:00
|
|
|
|
2015-03-18 00:06:58 +01:00
|
|
|
What is Dash?
|
2012-12-13 03:27:58 +01:00
|
|
|
----------------
|
|
|
|
|
2016-06-20 10:29:13 +02:00
|
|
|
Dash is an experimental digital currency that enables anonymous, instant
|
2015-03-18 00:06:58 +01:00
|
|
|
payments to anyone, anywhere in the world. Dash uses peer-to-peer technology
|
2014-12-12 12:09:19 +01:00
|
|
|
to operate with no central authority: managing transactions and issuing money
|
2016-06-30 19:21:00 +02:00
|
|
|
are carried out collectively by the network. Dash Core is the name of the open
|
2014-12-12 12:09:19 +01:00
|
|
|
source software which enables the use of this currency.
|
2012-12-13 03:27:58 +01:00
|
|
|
|
|
|
|
For more information, as well as an immediately useable, binary version of
|
2017-02-15 16:18:43 +01:00
|
|
|
the Dash Core software, see https://www.dash.org/get-dash/.
|
2014-12-12 12:09:19 +01:00
|
|
|
|
2012-12-13 03:27:58 +01:00
|
|
|
|
|
|
|
License
|
|
|
|
-------
|
|
|
|
|
2015-03-18 00:06:58 +01:00
|
|
|
Dash Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
|
2015-12-10 18:45:23 +01:00
|
|
|
information or see https://opensource.org/licenses/MIT.
|
2010-09-23 20:06:50 +02:00
|
|
|
|
2015-09-24 15:28:07 +02:00
|
|
|
Development Process
|
2012-12-13 03:27:58 +01:00
|
|
|
-------------------
|
2011-09-27 04:22:19 +02:00
|
|
|
|
2016-03-04 08:25:16 +01:00
|
|
|
The `master` branch is meant to be stable. Development is normally done in separate branches.
|
2016-05-31 06:56:46 +02:00
|
|
|
[Tags](https://github.com/dashpay/dash/tags) are created to indicate new official,
|
2016-03-04 08:25:16 +01:00
|
|
|
stable release versions of Dash Core.
|
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).
|
2014-04-09 20:11:08 +02:00
|
|
|
|
2013-01-09 21:55:47 +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
|
|
|
|
2016-11-02 23:35:52 +01:00
|
|
|
Developers are strongly encouraged to write [unit tests](src/test/README.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
|
2016-11-02 23:35:52 +01:00
|
|
|
(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](/src/test/README.md).
|
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`
|
2013-01-09 21:55:47 +01:00
|
|
|
|
2016-05-18 11:26:57 +02:00
|
|
|
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.
|
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
|
|
|
|
|
|
|
Translations
|
|
|
|
------------
|
|
|
|
|
|
|
|
Changes to translations as well as new translations can be submitted to
|
2016-03-04 08:25:16 +01:00
|
|
|
[Dash Core's Transifex page](https://www.transifex.com/projects/p/dash/).
|
2014-04-09 20:11:08 +02:00
|
|
|
|
2014-07-07 10:32:38 +02:00
|
|
|
Translations are periodically pulled from Transifex and merged into the git repository. See the
|
2014-04-09 20:11:08 +02:00
|
|
|
[translation process](doc/translation_process.md) for details on how this works.
|
|
|
|
|
2014-07-07 10:32:38 +02:00
|
|
|
**Important**: We do not accept translation changes as GitHub pull requests because the next
|
2014-04-09 20:11:08 +02:00
|
|
|
pull from Transifex would automatically overwrite them again.
|
|
|
|
|
2016-05-30 08:22:30 +02:00
|
|
|
Translators should also follow the [forum](https://www.dash.org/forum/topic/dash-worldwide-collaboration.88/).
|