maxmustermann/dogecoin
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
No description
24622 commits 12 branches 161 tags 1.2 GiB
C++ 65.7%
Python 15%
C 12.5%
M4 2.7%
Makefile 1.5%
Other 2.5%
Find a file
MarcoFalke c2bcb99c1d
Merge #19071: doc: Separate repository for the gui 
66666d55b1 doc: Mention repo split in the READMEs (MarcoFalke)
faceed753a doc: Add redirect for GUI issues and pull requests (MarcoFalke)

Pull request description:

  ## 🥅 Goals

  Splitting up the GUI (and splitting out modules in general) has been brought up often in recent years. Now that the GUI is primarily connected through (internal) interfaces with the node, it seems an appropriate time to revive this discussion.

  Before looking for solutions, we should define a set of goals that we want to achieve. I will start with some ideas to get started and I hope that others will chime in to share and prioritize their goals.

  ### Separate issue and patch management

  It is currently not possible to subscribe to only a subset of modules in Bitcoin Core, or exclude modules from issue and patch notifications. While it is possible to reactively mute conversations in the stream of all ongoing discussions, there is no way to proactively achieve this. Moreover, the list of open issues and pull request will always include GUI related ones by default. Only with [filters](https://github.com/bitcoin/bitcoin/pulls?q=is%3Aopen+is%3Apr+-label%3AGUI) it is possible to hide them.

  ### More focused review and interests

  Long term goals of the GUI are partially unclear #17395 . Bitcoin Core developers are generally fluent on the command line. Thus, they might not be interested or motivated to review improvements to the GUI, which might not affect their workflow on the command line at all.  Splitting up the GUI will hopefully attract similar minded people to a project whose primary goal is to build and improve the GUI.

  ### Maintain high quality assurance

  The quality of the GUI (and even more importantly Bitcoin Core in general) must not degrade. This means that code review itself is not negatively affected by splitting the GUI, but also the integration of the GUI into the rest of Bitcoin Core. One issue could arise when arbitrary version-combinations are allowed. We are struggling hard to test against all supported versions of Boost. Making the GUI version another dimension is going to make testing impossible.

  ### The GUI *is* Bitcoin Core

  When a user downloads Bitcoin Core from our website (or another package manager) they expect the GUI to be included. This should not change (at least not as a result of splitting up the GUI into another project).

  Similarly, when building Bitcoin Core, the gui should still be built when `--with-gui` is specified.

  ## 🌳 Proposed solution: Monotree

  TLDR. Everything stays the same, the development process for the GUI changes slightly.

  Long version:
  * An exact mirror of the master development branch is hosted at `bitcoin-core/gui`. The new repository is used to track gui-only issues and pull requests. Global changes that happen to touch gui code still go to the *main* repo.
  * All pull requests will be merged into `bitcoin/bitcoin`.
  * Decision making process and maintainers will be identical for both repos.

  ### Disadvantages

  * Review activity might decrease?

  * It doesn't go far enough. bitcoin/bitcoin#3440 is proposing a modularized Bitcoin Core. The GUI could be an "add-on", connected over RPC or capnproto (bitcoin/bitcoin#10102). Thus, the gui could even be hosted as a subtree or completely separate project.

  ### Advantages

  * Review activity might increase? It is impossible to predict the future, but for example the `libsecp256k1` subtree has a lot of domain specific experts, maintainers and reviewers. I think longer term it makes sense to at least try this route for the gui as well.

  * A smaller step is easier to undo when it turns out to come with any unforeseen downsides.

  * No substantial changes to the decision making progress.

  * Nothing changes in how developers set up their dev environment or how users build from the source. Also, the release binaries and process will stay exactly the same. No version drift. Finally, code sharing between the GUI and Bitcoin Core is not made any harder.

  * The organizational side. There are 72 open issues (~14%) and 61 open PRs (~16%) with the GUI label. If moved to its own repo, non-GUI developers wouldn't have to be distracted with GUI-only issues and PRs and GUI enhancements. GUI developers have their own repo to focus on GUI development exclusively.

  ### Implementation (outstanding TODOs)

  * Adjust maintainer merge script https://github.com/bitcoin-core/bitcoin-maintainer-tools/pull/57
  * Create bitcoin-core/gui repository (empty or with master branch only)
  * Assign all existing bitcoin core maintainers to the new repo
  * Celebrate? 🥳

  * Long-term: Think how long the grace period is for existing GUI related issues and pull requests. Issues can be transferred with a script after a grace period of some months?

ACKs for top commit:
  fjahr:
    ACK 66666d55b1
  Sjors:
    ACK 66666d55b1
  troygiorshev:
    re-ACK 66666d5
  practicalswift:
    re-ACK 66666d55b1
  hebasto:
    re-ACK 66666d55b1

Tree-SHA512: 2e1a8de945fa6995583059a2e322621763fccce74a869f9aa750f73546b26350487c4acc4222c03cb3ac1f88e80f0b9d9a3a80a200432fee0d785f52c5cb6174
2020-06-18 14:19:26 -04:00
.github doc: Add redirect for GUI issues and pull requests 2020-06-08 10:06:02 -04:00
.tx tx: Bump transifex slug to 020x 2020-03-16 10:52:55 +01:00
build-aux/m4 Merge #18297: build: Use pkg-config in BITCOIN_QT_CONFIGURE for all hosts including Windows 2020-06-13 15:41:39 +08:00
build_msvc Update MSVC build config for libsecp256k1 2020-06-09 13:41:38 -07:00
ci tests: run test-security-check.py in CI 2020-06-16 19:52:30 +08:00
contrib Merge #19287: contrib: Fix SyntaxWarning in Python base58 implementation 2020-06-17 17:05:15 +08:00
depends Merge #18297: build: Use pkg-config in BITCOIN_QT_CONFIGURE for all hosts including Windows 2020-06-13 15:41:39 +08:00
doc doc: release note for db log category removal 2020-06-07 17:59:55 +02:00
share Merge #18616: refactor: Cleanup clientversion.cpp 2020-05-13 20:14:51 +02:00
src Merge bitcoin-core/gui#3: scripted-diff: Make SeparatorStyle a scoped enum 2020-06-18 12:59:28 -04:00
test Merge #19304: test: Check that message sends successfully when header is split across two buffers 2020-06-18 07:39:37 -04:00
.appveyor.yml Merge #18640: appveyor: Remove clcache 2020-04-15 16:19:52 -04:00
.cirrus.yml cirrus: Remove no longer needed install step 2020-05-30 08:32:29 -04:00
.fuzzbuzz.yml ci: Add fuzzbuzz integration 2020-04-14 16:38:26 +00:00
.gitattributes
.gitignore Squashed 'src/secp256k1/' changes from b19c000063..2ed54da18a 2020-06-09 13:39:09 -07:00
.python-version .python-version: Specify full version 3.5.6 2019-03-02 12:06:26 -05:00
.style.yapf test: .style.yapf: Set column_limit=160 2019-03-04 18:28:13 -05:00
.travis.yml ci: Move travis workarounds to .travis.yml 2020-06-14 11:33:25 -04:00
autogen.sh scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
configure.ac build: don't warn when doxygen isn't found 2020-06-17 18:27:00 +08:00
CONTRIBUTING.md doc: Mention repo split in the READMEs 2020-06-08 10:06:14 -04:00
COPYING doc: Update license year range to 2020 2019-12-26 23:11:21 +01:00
INSTALL.md
libbitcoinconsensus.pc.in build: remove libcrypto as internal dependency in libbitcoinconsensus.pc 2019-11-19 15:03:44 +01:00
Makefile.am tests: run test-security-check.py in CI 2020-06-16 19:52:30 +08:00
README.md Squashed 'src/secp256k1/' changes from b19c000063..2ed54da18a 2020-06-09 13:39:09 -07:00
SECURITY.md Squashed 'src/secp256k1/' changes from b19c000063..2ed54da18a 2020-06-09 13:39:09 -07:00

README.md

Bitcoin Core integration/staging tree

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 usable, 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 (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 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.