Skip to content

doc: Updated notes on how to contribute to Bitcoin Knots. #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pdath wants to merge 1 commit into
base: 29.x-knots
Choose a base branch
from
Open

doc: Updated notes on how to contribute to Bitcoin Knots. #314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 19 additions & 27 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ welcome to contribute towards development in the form of peer review, testing
and patches. This document explains the practical process and guidelines for
contributing.

First, in terms of structure, there is no particular concept of "core
First, in terms of structure, there is no particular concept of "knots
developers" in the sense of privileged people. Open source often naturally
revolves around a meritocracy where contributors earn trust from the developer
community over time. Nevertheless, some hierarchy is necessary for practical
Expand All @@ -24,19 +24,18 @@ as a new contributor. It also will teach you much more about the code and
process than opening pull requests. Please refer to the [peer review](#peer-review)
section below.

Before you start contributing, familiarize yourself with the Bitcoin Core build
Before you start contributing, familiarize yourself with the Bitcoin Knots build
system and tests. Refer to the documentation in the repository on how to build
Bitcoin Core and how to run the unit tests, functional tests, and fuzz tests.
Bitcoin Knots and how to run the unit tests, functional tests, and fuzz tests.

There are many open issues of varying difficulty waiting to be fixed.
If you're looking for somewhere to start contributing, check out the
[good first issue](https://github.com/bitcoin/bitcoin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
list or changes that are
[up for grabs](https://github.com/bitcoin/bitcoin/issues?utf8=%E2%9C%93&q=label%3A%22Up+for+grabs%22).
[good first issue](https://github.com/bitcoinknots/bitcoin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
list.
Some of them might no longer be applicable. So if you are interested, but
unsure, you might want to leave a comment on the issue first.

You may also participate in the [Bitcoin Core PR Review Club](https://bitcoincore.reviews/).
You may also participate in the [Bitcoin Knots Discord](https://discord.gg/3Ccegp9YrU).

### Good First Issue Label

Expand All @@ -51,25 +50,19 @@ you are encouraged to leave a comment if you are planning to work on it. This
will help other contributors monitor which issues are actively being addressed
and is also an effective way to request assistance if and when you need it.

Communication Channels
----------------------
Bitcoin Knots Communication Channels
------------------------------------

Most communication about Bitcoin development happens on IRC, in the
`#bitcoin-core-dev` channel on Libera Chat. The easiest way to participate on IRC is
with the web client, [web.libera.chat](https://web.libera.chat/#bitcoin-core-dev). Chat
history logs can be found
on [https://www.erisian.com.au/bitcoin-core-dev/](https://www.erisian.com.au/bitcoin-core-dev/)
and [https://gnusha.org/bitcoin-core-dev/](https://gnusha.org/bitcoin-core-dev/).
Most communication about Bitcoin Knots development happens on Discord, in the
`#dev` channel. You can join the Bitcoin Knots Discord with this [invitation
link](https://discord.gg/3Ccegp9YrU).

The easiest way to participate on Discord is with the web client,
[https://discord.com/channels/@me](https://discord.com/channels/@me).

Discussion about codebase improvements happens in GitHub issues and pull
requests.

The developer
[mailing list](https://groups.google.com/g/bitcoindev)
should be used to discuss complicated or controversial consensus or P2P protocol changes before working on
a patch set.
Archives can be found on [https://gnusha.org/pi/bitcoindev/](https://gnusha.org/pi/bitcoindev/).


Contributor Workflow
--------------------
Expand All @@ -84,8 +77,7 @@ To contribute a patch, the workflow is as follows:
1. Create topic branch
1. Commit patches

For GUI-related issues or pull requests, the https://github.com/bitcoin-core/gui repository should be used.
For all other issues and pull requests, the https://github.com/bitcoin/bitcoin node repository should be used.
For all issues and pull requests, the https://github.com/bitcoinknots/bitcoin node repository should be used.

The master branch for all monotree repositories is identical.

Expand All @@ -104,7 +96,7 @@ recommended to first open a pull request against the GUI repository. When there
is agreement to proceed with the changes, a pull request with the build system
and interfaces changes can be submitted to the node repository.

The project coding conventions in the [developer notes](doc/developer-notes.md)
The project coding conventions in the [developer notes](https://github.com/bitcoinknots/bitcoin/blob/29.x-knots/doc/developer-notes.md)
must be followed.

### Committing Patches
Expand Down Expand Up @@ -170,13 +162,13 @@ mailing list discussions).
The description for a new pull request should not contain any `@` mentions. The
PR description will be included in the commit message when the PR is merged and
any users mentioned in the description will be annoyingly notified each time a
fork of Bitcoin Core copies the merge. Instead, make any username mentions in a
fork of Bitcoin Knots copies the merge. Instead, make any username mentions in a
subsequent comment to the PR.

### Translation changes

Note that translations should not be submitted as pull requests. Please see
[Translation Process](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md)
[Translation Process](https://github.com/bitcoinknots/bitcoin/blob/master/doc/translation_process.md)
for more information on helping with translations.

### Work in Progress Changes and Requests for Comments
Expand Down Expand Up @@ -232,7 +224,7 @@ pull request to pull request.

When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch.

git fetch https://github.com/bitcoin/bitcoin # Fetch the latest upstream commit
git fetch https://github.com/bitcoinknots/bitcoin # Fetch the latest upstream commit
git rebase FETCH_HEAD # Rebuild commits on top of the new base

This project aims to have a clean git history, where code changes are only made in non-merge commits. This simplifies
Expand Down