mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 18:09:47 +01:00
Code Issues Projects Releases Wiki Activity
Bitcoin Core integration/staging tree
42,522 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%
fea550b480
Go to file
merge-script fea550b480
Merge bitcoin/bitcoin#30890: doc: unit test runner help fixup and improvements 
282f0e9255 Unit test runner documentation fix and improvements (Jon Atack)

Pull request description:

  Running `test_bitcoin --help` prints the list of arguments that may be passed, not the list of tests, so fix that.

  Improve the content and order of the unit test documentation.

ACKs for top commit:
  pablomartin4btc:
    re-ACK 282f0e9255
  tdb3:
    re ACK 282f0e9255

Tree-SHA512: 0d25108ab641bcd9b53f99d139afeec90a34f44d5b00c3c677f7539d87782440a28fadc348663b8c28ace43552834737b9c1e8f5517c68edc8547695a9cb5063
2024-09-13 16:58:38 +01:00
.github Squashed 'src/secp256k1/' changes from 642c885b61..2f2ccc4695 2024-09-07 18:12:35 +01:00
.tx qt: Bump Transifex slug for 28.x 2024-07-30 16:14:19 +01:00
ci Squashed 'src/secp256k1/' changes from 642c885b61..2f2ccc4695 2024-09-07 18:12:35 +01:00
cmake Revert "build: Minimize I/O operations in GenerateHeaderFrom{Json,Raw}.cmake" 2024-09-12 16:34:57 +01:00
contrib contrib: test for FORTIFY_SOURCE in security-check.py 2024-09-09 12:35:13 +01:00
depends depends: Update libmultiprocess library for CustomMessage function and ThreadContext bugfix 2024-09-06 09:08:10 -04:00
doc Merge bitcoin/bitcoin#30871: build: Add more cmake presets 2024-09-12 11:33:15 +01:00
share build: Remove Autotools-based build system 2024-08-30 21:31:39 +01:00
src Merge bitcoin/bitcoin#30890: doc: unit test runner help fixup and improvements 2024-09-13 16:58:38 +01:00
test Merge bitcoin/bitcoin#30880: test: Wait for local services to update in feature_assumeutxo 2024-09-12 14:52:14 -04:00
.cirrus.yml ci: forks can opt-out of CI branch push (Cirrus only) 2024-06-25 20:03:44 +02:00
.editorconfig
.gitattributes
.gitignore build: Remove Autotools-based build system 2024-08-30 21:31:39 +01:00
.python-version Bump .python-version from 3.9.17 to 3.9.18 2023-10-24 18:51:24 +02:00
.style.yapf Update .style.yapf 2023-06-01 23:35:10 +05:30
CMakeLists.txt build: use standard branch-protection for aarch64-linux 2024-09-13 11:26:40 +01:00
CMakePresets.json build: add more CMake presets (dev-mode, libfuzzer, libfuzzer-nosan) 2024-09-11 12:51:34 -04:00
CONTRIBUTING.md doc: replace Autotools with CMake 2024-08-29 16:06:29 +01:00
COPYING doc: upgrade Bitcoin Core license to 2024 2024-01-10 16:29:01 -06:00
INSTALL.md doc: Added hyperlink for doc/build 2021-09-09 19:53:12 +05:30
libbitcoinkernel.pc.in build: Add a pkg-config file for libbitcoinkernel 2024-09-06 21:35:07 +02:00
README.md doc: Update for CMake-based build system 2024-08-16 21:24:08 +01:00
SECURITY.md Update security.md contact for achow101 2023-12-14 18:14:54 -05:00
vcpkg.json cmake: Add vcpkg manifest file 2024-08-16 21:19:12 +01:00

README.md

Bitcoin Core integration/staging tree

https://bitcoincore.org

For an immediately usable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/.

What is Bitcoin Core?

Bitcoin Core connects to the Bitcoin peer-to-peer network to download and fully validate blocks and transactions. It also includes a wallet and graphical user interface, which can be optionally built.

Further information about Bitcoin Core is available in the doc folder.

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 (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 Bitcoin Core.

The https://github.com/bitcoin-core/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.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 during the generation of the build system) with: ctest. 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. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The CI (Continuous Integration) systems make 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.