diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46e1bce7e19..fb432c49060 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ Pull requests should be focused on a single change. Do not mix, for example, ref ## 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): +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: @@ -60,7 +60,7 @@ From https://chris.beams.io/posts/git-commit/#seven-rules: 6. Wrap the body at 72 characters 7. Use the body to explain what and why vs. how -([bisq-network/style#9](https://github.com/bisq-network/style/issues/9)) +See also [bisq-network/style#9](https://github.com/bisq-network/style/issues/9). ### Sign your commits with GPG @@ -71,7 +71,7 @@ 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. ([bisq-network/style#9](https://github.com/bisq-network/style/issues/9)) +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). ### Additional style guidelines diff --git a/docs/dao-setup.md b/docs/dao-setup.md index a8f688c6b00..6163f8350cd 100644 --- a/docs/dao-setup.md +++ b/docs/dao-setup.md @@ -34,14 +34,14 @@ It defines the ports where a new block event gets forwarded. Bisq will listen on ## Program arguments for DAO mode -`--daoActivated`: If set to true it enables the DAO mode. For testnet and regtest it is enabled by default. -`--genesisBlockHeight`: If set it overrides the hard coded block height of the genesis tx. Set it to your local genesis tx height. -`--genesisTxId`: If set it overrides the hard coded genesis tx ID. Set it to your local genesis tx ID. -`--fullDaoNode`: If true it enables full DAO node mode (in contrast to default lite node mode). At least one seed node must be running as a full DAO node to support other lite nodes. -`--rpcUser`: RPC user as defined in bitcoin.conf -`--rpcPassword`: RPC pw as defined in bitcoin.conf -`--rpcPort`: RPC port. For regtest 18443 -`--rpcBlockNotificationPort`: One of the ports defined in the `blocknotify` file inside the Bitcoin data directory (see: DAO setup for Bitcoin Core). + - `--daoActivated`: If set to true it enables the DAO mode. For testnet and regtest it is enabled by default. + - `--genesisBlockHeight`: If set it overrides the hard coded block height of the genesis tx. Set it to your local genesis tx height. + - `--genesisTxId`: If set it overrides the hard coded genesis tx ID. Set it to your local genesis tx ID. + - `--fullDaoNode`: If true it enables full DAO node mode (in contrast to default lite node mode). At least one seed node must be running as a full DAO node to support other lite nodes. + - `--rpcUser`: RPC user as defined in bitcoin.conf + - `--rpcPassword`: RPC pw as defined in bitcoin.conf + - `--rpcPort`: RPC port. For regtest 18443 + - `--rpcBlockNotificationPort`: One of the ports defined in the `blocknotify` file inside the Bitcoin data directory (see: DAO setup for Bitcoin Core). ## DAO mode diff --git a/docs/dev-setup.md b/docs/dev-setup.md index 7b5fea0f30b..b2a6ba721d3 100644 --- a/docs/dev-setup.md +++ b/docs/dev-setup.md @@ -30,7 +30,7 @@ Navigate to the [bitcoin.conf](https://en.bitcoin.it/wiki/Running_Bitcoin#Bitcoi At first startup you need to create 101 blocks using the command `generate 101` from the terminal inside Bitcoin Core. 101 blocks are required because of the coin maturity (100 blocks) so you need one more to have at least 50 BTC available for spending. -Later you can create a new blocks with `generate 1`. +Later you can create new blocks with `generate 1`. ## Understand Bisq P2P network options