The CONTRIBUTING.md file must be located in the root directory of a project (or within a .github directory) in order to be recognized by GitHub and presented to users during the process of filing an issue or pull request. It doesn't do any good within the docs/ directory.
1.3 KiB
Contributing to Bisq
Pull requests
To contribute a patch, the workflow is as follows:
- Fork repository
- Create topic branch from
master
branch - Commit patches
Submit your pull request from your topic branch to the master
branch.
Workflow for merging code
We are aiming to follow the principles and establish the workflow used at the Bitcoin Core project. Please check out the Bitcoin Core documentation for more info. The full workflow is not used yet as there are not that many dedicated developers yet, but as soon that situation changes we will move to a model with ACK/NACK, code reviews and maintainer roles.
Copyright
By contributing to this repository, you agree to license your work under the AGPL license. Please include the bisq license header into your files.
Compensation for your contributions
Bisq is not a company but operates as a DAO. For any development work merged into the Bisq master branch you can file a compensation request and earn BSQ (the DAO native token). Learn more about the Bisq DAO at our docs pages.