mirror of
https://github.com/bisq-network/bisq.git
synced 2024-11-19 01:41:11 +01:00
93 lines
4.9 KiB
Markdown
93 lines
4.9 KiB
Markdown
# Contributing to Bisq
|
|
|
|
Anyone is welcome to contribute to Bisq. This document provides an overview of how we work. If you're looking for somewhere to start contributing, see the [good first issue](https://github.com/bisq-network/bisq/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") list.
|
|
|
|
|
|
## Communication Channels
|
|
|
|
Most communication about Bisq happens in the [Bisq Slack workspace](https://bisq.network/slack-invite).
|
|
|
|
Discussion about code changes happens in GitHub issues and pull requests.
|
|
|
|
Discussion about larger changes to the way Bisq works happens in issues the [bisq-network/proposals](https://github.com/bisq-network/proposals/issues) repository. See https://docs.bisq.network/proposals.html for details.
|
|
|
|
|
|
## Contributor Workflow
|
|
|
|
All Bisq contributors submit changes via pull requests. The workflow is as follows:
|
|
|
|
- Fork the repository
|
|
- Create a topic branch from the `master` branch
|
|
- Commit patches
|
|
- Squash redundant or unnecessary commits
|
|
- Submit a pull request from your topic branch back to the `master` branch of the main repository
|
|
|
|
Pull requests should be focused on a single change. Do not mix, for example, refactorings with a bug fix or implementation of a new feature. This practice makes it easier for fellow contributors to review each pull request on its merits and to give a clear ACK/NACK (see below).
|
|
|
|
|
|
## Reviewing Pull Requests
|
|
|
|
Bisq follows the review workflow established by the Bitcoin Core project. The following is adapted from the [Bitcoin Core contributor documentation](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#peer-review):
|
|
|
|
Anyone may participate in peer review which is expressed by comments in the pull request. Typically reviewers will review the code for obvious errors, as well as test out the patch set and opine on the technical merits of the patch. Project maintainers take into account the peer review when determining if there is consensus to merge a pull request (remember that discussions may have been spread out over GitHub, mailing list and IRC discussions). The following language is used within pull-request comments:
|
|
|
|
- `ACK` means "I have tested the code and I agree it should be merged";
|
|
- `NACK` means "I disagree this should be merged", and must be accompanied by sound technical justification. NACKs without accompanying reasoning may be disregarded;
|
|
- `utACK` means "I have not tested the code, but I have reviewed it and it looks OK, I agree it can be merged";
|
|
- `Concept ACK` means "I agree in the general principle of this pull request";
|
|
- `Nit` refers to trivial, often non-blocking issues.
|
|
|
|
Please note that Pull Requests marked `NACK` and/or Github's `Change requested` are closed after 30 days if not addressed.
|
|
|
|
|
|
## Compensation
|
|
|
|
Bisq is not a company, but operates as a _decentralized autonomous organization_ (DAO). For any work merged into Bisq's `master` branch, you can [submit a compensation request](https://docs.bisq.network/dao/phase-zero.html#how-to-request-compensation) and earn BSQ (the Bisq DAO native token). Learn more about the Bisq DAO and BSQ [here](https://docs.bisq.network/dao/phase-zero.html).
|
|
|
|
|
|
## Style and Coding Conventions
|
|
|
|
### Configure Git user name and email metadata
|
|
|
|
See https://help.github.com/articles/setting-your-username-in-git/ for instructions.
|
|
|
|
### Write well-formed commit messages
|
|
|
|
From https://chris.beams.io/posts/git-commit/#seven-rules:
|
|
|
|
1. Separate subject from body with a blank line
|
|
2. Limit the subject line to 50 characters
|
|
3. Capitalize the subject line
|
|
4. Do not end the subject line with a period
|
|
5. Use the imperative mood in the subject line
|
|
6. Wrap the body at 72 characters
|
|
7. Use the body to explain what and why vs. how
|
|
|
|
See also [bisq-network/style#9](https://github.com/bisq-network/style/issues/9).
|
|
|
|
### Sign your commits with GPG
|
|
|
|
_Not strictly required, but recommended for those who commit frequently._
|
|
|
|
See https://github.com/blog/2144-gpg-signature-verification for background and
|
|
https://help.github.com/articles/signing-commits-with-gpg/ for instructions.
|
|
|
|
### Use an editor that supports Editorconfig
|
|
|
|
The [.editorconfig](.editorconfig) settings in this repository ensure consistent management of whitespace, line endings and more. Most modern editors support it natively or with plugin. See http://editorconfig.org for details. See also [bisq-network/style#10](https://github.com/bisq-network/style/issues/10).
|
|
|
|
### Keep the git history clean
|
|
|
|
It's very important to keep the git history clear, light and easily browsable. This means contributors must make sure their pull requests include only meaningful commits (if they are redundant or were added after a review, they should be removed) and _no merge commits_.
|
|
|
|
### Additional style guidelines
|
|
|
|
See the issues in the [bisq-network/style](https://github.com/bisq-network/style/issues) repository.
|
|
|
|
|
|
## See also
|
|
|
|
- [contributor checklist](https://docs.bisq.network/contributor-checklist.html)
|
|
- [developer docs](docs#readme) including build and dev environment setup instructions
|
|
|