mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-20 10:38:42 +01:00
Code Issues Projects Releases Wiki Activity
Bitcoin Core integration/staging tree
18,442 Commits 6 Branches 318 Tags 3.2 GiB
C++ 64%
Python 19.9%
C 12.4%
CMake 1.1%
Shell 0.9%
Other 1.6%
d6189ff200
Go to file
MarcoFalke d6189ff200
Merge #14390: docs: release process: RPC documentation 
3b706212ad doc: RPC documentation (Karel Bílek)

Pull request description:

  The auto-generated RPC docs seem to work so far ( https://bitcoincore.org/en/doc/ + 0.17.0 https://github.com/bitcoin-core/bitcoincore.org/pull/618 ). There are some problems (the design of the list on the right is not ideal, and apparently the huge list of pages slows down jekyll), but that can be fixed later; people are already linking to the docs now and looking for them there

  So I am adding the RPC docs to the release process.

  The script is here and it is written in golang, since I am most confident in the language; if necessary, I can try to rewrite to python, which is more common in bitcoin tooling

  https://github.com/bitcoin-core/bitcoincore.org/tree/master/contrib/doc-gen

Tree-SHA512: ba1b7696bb7ceb6cee4ff222b006b8c18768dd9283a4130751714a782d75ea2ca33f8d9fc4a5263d85a2f001c254daa0cee3b09cc7cba7366c66c5a115d8352a
2018-10-08 03:01:34 -03:00
.github doc: Add GitHub pr template 2018-09-23 08:31:11 -04:00
.travis travis: set codespell version to avoid breakage 2018-10-03 18:59:03 -03:00
.tx tx: Update transifex slug 016x→017x 2018-08-02 13:42:15 +02:00
build_msvc appveyor: Use clcache to speed up build 2018-09-03 23:55:00 +08:00
build-aux/m4 Merge #13095: build: update ax_boost_chrono/unit_test_framework 2018-07-26 08:54:59 -04:00
contrib [gitian] use versioned unsigned tarballs instead of generically named ones 2018-09-25 22:07:33 -04:00
depends Merge #14264: doc: Split depends installation instructions per arch 2018-10-04 00:58:08 -03:00
doc Merge #14390: docs: release process: RPC documentation 2018-10-08 03:01:34 -03:00
share Merge #14018: Bugfix: NSIS: Exclude Makefile* from docs 2018-08-22 15:28:52 +02:00
src Merge #14428: docs: Fix macOS files description in qt/README.md 2018-10-08 02:54:56 -03:00
test Merge #14324: qa: Run more tests with wallet disabled 2018-10-08 01:42:02 -03:00
.appveyor.yml appveyor: trivial build cache modifications 2018-10-05 13:46:40 +08:00
.gitattributes
.gitignore
.travis.yml qa: Run more tests with wallet disabled 2018-09-25 18:08:08 -04:00
autogen.sh
configure.ac configure: Make it possible to build only one of bitcoin-cli or bitcoin-tx 2018-09-13 11:48:23 +00:00
CONTRIBUTING.md doc: add note to contributor docs about warranted PR's 2018-07-30 23:47:46 +09:00
COPYING
INSTALL.md
libbitcoinconsensus.pc.in
Makefile.am lcov: filter /usr/lib/ from coverage reports 2018-09-20 14:01:53 -04:00
README.md doc: Adjust bitcoincore.org links 2018-07-22 10:32:38 -04:00

README.md

Bitcoin Core integration/staging tree

Build Status

https://bitcoincore.org

What is Bitcoin?

Bitcoin is an experimental digital currency that enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. Bitcoin 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 Bitcoin Core software, see https://bitcoincore.org/en/download/, or read the original whitepaper.

License

Bitcoin 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. Tags are created regularly to indicate new official, stable release versions of Bitcoin Core.

The contribution workflow is described in CONTRIBUTING.md.

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. 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 are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, 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.

Translations

Changes to translations as well as new translations can be submitted to Bitcoin Core's Transifex page.

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.

Translators should also subscribe to the mailing list.