mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-11 20:32:35 -03:00
53eec53dca
d8311688bd Merge bitcoin-core/secp256k1#1515: ci: Note affected clangs in comment on ASLR quirk a85e2233e7 ci: Note affected clangs in comment on ASLR quirk 4b77fec67a Merge bitcoin-core/secp256k1#1512: msan: notate more variable assignments from assembly code f7f0184ba1 msan: notate more variable assignments from assembly code a61339149f change inconsistent array param to pointer 05bfab69ae Merge bitcoin-core/secp256k1#1507: ci: Add workaround for ASLR bug in sanitizers a5e8ab2484 ci: Add sanitizer env variables to debug output 84a93de4d2 ci: Add workaround for ASLR bug in sanitizers 427e86b9ed Merge bitcoin-core/secp256k1#1490: tests: improve fe_sqr test (issue #1472) 2028069df2 doc: clarify input requirements for secp256k1_fe_mul 11420a7a28 tests: improve fe_sqr test cdc9a6258e Merge bitcoin-core/secp256k1#1489: tests: add missing fe comparison checks for inverse field test cases d926510cf7 Merge bitcoin-core/secp256k1#1496: msan: notate variable assignments from assembly code 31ba404944 msan: notate variable assignments from assembly code e7ea32e30a msan: Add SECP256K1_CHECKMEM_MSAN_DEFINE which applies to memory sanitizer and not valgrind e7bdddd9c9 refactor: rename `check_fe_equal` -> `fe_equal` 00111c9c56 tests: add missing fe comparison checks for inverse field test cases 0653a25d50 Merge bitcoin-core/secp256k1#1486: ci: Update cache action 94a14d5290 ci: Update cache action 2483627299 Merge bitcoin-core/secp256k1#1483: cmake: Recommend native CMake commands in README 5ad3aa3dcd Merge bitcoin-core/secp256k1#1484: tests: Drop redundant _scalar_check_overflow calls 51df2d9ab3 tests: Drop redundant _scalar_check_overflow calls 3777e3f36a cmake: Recommend native CMake commands in README e4af41c61b Merge bitcoin-core/secp256k1#1249: cmake: Add `SECP256K1_LATE_CFLAGS` configure option 3bf4d68fc0 Merge bitcoin-core/secp256k1#1482: build: Clean up handling of module dependencies e6822678ea build: Error if required module explicitly off 89ec583ccf build: Clean up handling of module dependencies 44378867a0 Merge bitcoin-core/secp256k1#1468: v0.4.1 release aftermath a9db9f2d75 Merge bitcoin-core/secp256k1#1480: Get rid of untested sizeof(secp256k1_ge_storage) == 64 code path 74b7c3b53e Merge bitcoin-core/secp256k1#1476: include: make docs more consistent b37fdb28ce check-abi: Minor UI improvements ad5f589a94 check-abi: Default to HEAD for new version 9fb7e2f156 release process: Style and formatting nits ba5d72d626 assumptions: Use new STATIC_ASSERT macro e53c2d9ffc Require that sizeof(secp256k1_ge_storage) == 64 d0ba2abbff util: Add STATIC_ASSERT macro da7bc1b803 include: in doc, remove article in front of "pointer" aa3dd5280b include: make doc about ctx more consistent e3f690015a include: remove obvious "cannot be NULL" doc d373bf6d08 Merge bitcoin-core/secp256k1#1474: tests: restore scalar_mul test 79e094517c Merge bitcoin-core/secp256k1#1473: Fix typos 3dbfb48946 tests: restore scalar_mul test d77170a88d Fix typos e7053d065b release process: Add email step 429d21dc79 release process: Run sanity checks on release PR 42f8c51402 cmake: Add `SECP256K1_LATE_CFLAGS` configure option git-subtree-dir: src/secp256k1 git-subtree-split: d8311688bd383d3a923a1b11789cded3cc8e5e03
78 lines
3.3 KiB
Markdown
78 lines
3.3 KiB
Markdown
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](/doc).
|
|
|
|
License
|
|
-------
|
|
|
|
Bitcoin Core is released under the terms of the MIT license. See [COPYING](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](https://github.com/bitcoin/bitcoin/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](CONTRIBUTING.md)
|
|
and useful hints for developers can be found in [doc/developer-notes.md](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](src/test/README.md) 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](/src/test/README.md).
|
|
|
|
There are also [regression and integration tests](/test), written
|
|
in Python.
|
|
These tests can be run (if the [test dependencies](/test) 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](https://www.transifex.com/bitcoin/bitcoin/).
|
|
|
|
Translations are periodically pulled from Transifex and merged into the git repository. See the
|
|
[translation process](doc/translation_process.md) 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.
|