You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.5KB

11 years ago
11 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. Bitcoin Core integration/staging tree
  2. =====================================
  3. [![Build Status](https://travis-ci.org/bitcoin/bitcoin.svg?branch=master)](https://travis-ci.org/bitcoin/bitcoin)
  4. https://bitcoincore.org
  5. What is Bitcoin?
  6. ----------------
  7. Bitcoin is an experimental digital currency that enables instant payments to
  8. anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
  9. with no central authority: managing transactions and issuing money are carried
  10. out collectively by the network. Bitcoin Core is the name of open source
  11. software which enables the use of this currency.
  12. For more information, as well as an immediately useable, binary version of
  13. the Bitcoin Core software, see https://bitcoin.org/en/download, or read the
  14. [original whitepaper](https://bitcoincore.org/bitcoin.pdf).
  15. License
  16. -------
  17. Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
  18. information or see https://opensource.org/licenses/MIT.
  19. Development Process
  20. -------------------
  21. The `master` branch is regularly built and tested, but is not guaranteed to be
  22. completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
  23. regularly to indicate new official, stable release versions of Bitcoin Core.
  24. The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).
  25. The developer [mailing list](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev)
  26. should be used to discuss complicated or controversial changes before working
  27. on a patch set.
  28. Developer IRC can be found on Freenode at #bitcoin-core-dev.
  29. Testing
  30. -------
  31. Testing and code review is the bottleneck for development; we get more pull
  32. requests than we can review and test on short notice. Please be patient and help out by testing
  33. other people's pull requests, and remember this is a security-critical project where any mistake might cost people
  34. lots of money.
  35. ### Automated Testing
  36. Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to
  37. submit new unit tests for old code. Unit tests can be compiled and run
  38. (assuming they weren't disabled in configure) with: `make check`. Further details on running
  39. and extending unit tests can be found in [/src/test/README.md](/src/test/README.md).
  40. There are also [regression and integration tests](/test), written
  41. in Python, that are run automatically on the build server.
  42. These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py`
  43. 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.
  44. ### Manual Quality Assurance (QA) Testing
  45. Changes should be tested by somebody other than the developer who wrote the
  46. code. This is especially important for large or high-risk changes. It is useful
  47. to add a test plan to the pull request description if testing the changes is
  48. not straightforward.
  49. Translations
  50. ------------
  51. Changes to translations as well as new translations can be submitted to
  52. [Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/).
  53. Translations are periodically pulled from Transifex and merged into the git repository. See the
  54. [translation process](doc/translation_process.md) for details on how this works.
  55. **Important**: We do not accept translation changes as GitHub pull requests because the next
  56. pull from Transifex would automatically overwrite them again.
  57. Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators).