foster/bitcoin-bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-09 10:43:19 -05:00
Code Issues Activity
Bitcoin Core integration/staging tree
42464 commits 6 branches 321 tags 2.3 GiB
C++ 56.4%
C 22.7%
Python 17.6%
CMake 1%
Shell 0.8%
Other 1.3%
Find a file
Ava Chow a8809aeb6e
Merge bitcoin/bitcoin#30870: docs: updated developer notes for --with-sanitizers to -DSANITIZERS 
4b1ce3cac8 docs: updated developer notes for --with-sanitizers to -DSANITIZERS and removed resource for -fsanitze flags (kevkevinpal)

Pull request description:

  In the developer notes we are incorrectly using the Autotools `--with-sanitizers` configure flag which we should now be using `cmake -B build -DSANITIZERS=<values>` instead now

ACKs for top commit:
  maflcko:
    review ACK 4b1ce3cac8
  achow101:
    ACK 4b1ce3cac8
  pablomartin4btc:
    ACK 4b1ce3cac8

Tree-SHA512: 029d55d802f6b4a85f3541f9a23e9ac85e6c590e91081204bfa737169138f61877883db51ad99cd8b802b0737eec35df5a33a5351b3e6b2f180f3ad0282d3616
2024-09-11 13:18:10 -04: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 cmake: add USE_SOURCE_PERMISSIONS to all configure_file usage 2024-09-06 10:52:19 +01:00
contrib Merge bitcoin/bitcoin#30415: contrib: fix check-deps.sh to check for weak symbols 2024-09-06 10:51:34 +01:00
depends depends: Update libmultiprocess library for CustomMessage function and ThreadContext bugfix 2024-09-06 09:08:10 -04:00
doc docs: updated developer notes for --with-sanitizers to -DSANITIZERS and removed resource for -fsanitze flags 2024-09-11 10:26:58 -04:00
share build: Remove Autotools-based build system 2024-08-30 21:31:39 +01:00
src Merge bitcoin/bitcoin#30773: Remove unsafe uint256S() and test-only uint160S() 2024-09-10 15:41:35 -04:00
test Merge bitcoin/bitcoin#30805: test: Add explicit onion bind to p2p_permissions 2024-09-10 21:49:47 -04:00
.cirrus.yml ci: forks can opt-out of CI branch push (Cirrus only) 2024-06-25 20:03:44 +02:00
.editorconfig ci: Drop AppVeyor CI integration 2021-09-07 06:12:53 +03:00
.gitattributes Separate protocol versioning from clientversion 2014-10-29 00:24:40 -04:00
.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 Merge bitcoin/bitcoin#30824: cmake: decouple FORTIFY_SOURCE check from Debug build type 2024-09-09 12:33:57 +01:00
CMakePresets.json ci: Add missed configuration options to "Win64 native" job 2024-09-06 12:19:26 +01: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
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.