Skip to content

Commit 66666d5

Browse files
author
MarcoFalke
committed
doc: Mention repo split in the READMEs
1 parent faceed7 commit 66666d5

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,26 @@ To contribute a patch, the workflow is as follows:
8484
1. Create topic branch
8585
1. Commit patches
8686

87+
For GUI-related issues or pull requests, the https://github.com/bitcoin-core/gui repository should be used.
88+
For all other issues and pull requests, the https://github.com/bitcoin/bitcoin node repository should be used.
89+
90+
The master branch for all monotree repositories is identical.
91+
92+
As a rule of thumb, everything that only modifies `src/qt` is a GUI-only pull
93+
request. However:
94+
95+
* For global refactoring or other transversal changes the node repository
96+
should be used.
97+
* For GUI-related build system changes, the node repository should be used
98+
because the change needs review by the build systems reviewers.
99+
* Changes in `src/interfaces` need to go to the node repository because they
100+
might affect other components like the wallet.
101+
102+
For large GUI changes that include build system and interface changes, it is
103+
recommended to first open a pull request against the GUI repository. When there
104+
is agreement to proceed with the changes, a pull request with the build system
105+
and interfaces changes can be submitted to the node repository.
106+
87107
The project coding conventions in the [developer notes](doc/developer-notes.md)
88108
must be followed.
89109

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,14 @@ information or see https://opensource.org/licenses/MIT.
2525
Development Process
2626
-------------------
2727

28-
The `master` branch is regularly built (see doc/build-*.md for instructions) and tested, but is not guaranteed to be
28+
The `master` branch is regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to be
2929
completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
30-
regularly to indicate new official, stable release versions of Bitcoin Core.
30+
regularly from release branches to indicate new official, stable release versions of Bitcoin Core.
31+
32+
The https://github.com/bitcoin-core/gui repository is used exclusively for the
33+
development of the GUI. Its master branch is identical in all monotree
34+
repositories. Release branches and tags do not exist, so please do not fork
35+
that repository unless it is for development reasons.
3136

3237
The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md)
3338
and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md).

0 commit comments

Comments
 (0)