diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f2fc29bbb7e340cac366e9902cb07b5ddf9dd7c..2ea12ca8012ac0e702752a8f807a07dcf468ab79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,28 +19,21 @@ Please read [Developer documentation] before contribute. - Create a branch based on `master` and prefixed with your nickname. Give your branch a short name indicating the subject. - Create an MR from your branch to `master`. -- Never contribute to a branch of ahother contributor! If the contributor make a `git rebase` your commit will be lost ! +- Never contribute to a branch of another contributor! If the contributor makes a `git rebase` your commit will be lost! - Before you push your commit: - Apply formatters (rustfmt and prettier) and linter (clippy) - - Document your code. + - Document your code - Apply the [project's git conventions] ## Merge Process 1. Ensure you rebased your branch on the latest `master` commit to avoid any merge conflicts. - -2. Ensure that you respect the [commit naming conventions]. - -3. Ensure that all automated tests pass with the `cargo test` command. - -3. Ensure that the code is well formated `cargo fmt` and comply with the good practices `cargo clippy`. If you have been working on tests, check everything with `cargo clippy --all --tests`. - -4. Update the documentation with details of changes to the interface, this includes new environment - variables, exposed ports, useful file locations and container parameters. - -5. Push your branch on the gitlab and create a merge request. Briefly explain the purpose of your contribution in the description of the merge request. - -6. Tag a Duniter reviewer so they will review your contribution. If you still have no news after several weeks, tag another reviewer or/and talk about your contribution on [the technical forum]. +1. Ensure that you respect the [commit naming conventions]. +1. Ensure that all automated tests pass with the `cargo test` command. +1. Ensure that the code is well formated `cargo fmt` and comply with the good practices `cargo clippy`. If you have been working on tests, check everything with `cargo clippy --all --tests`. +1. Update the documentation with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. +1. Push your branch on the gitlab and create a merge request. Briefly explain the purpose of your contribution in the description of the merge request. +1. Tag a Duniter reviewer so they will review your contribution. If you still have no news after several weeks, tag another reviewer or/and talk about your contribution on [the technical forum]. ## List of Duniter's reviewers diff --git a/docs/api/manual.md b/docs/api/manual.md index 6dd762be5483b8dc0dce5a0a9d085a468963a76c..86700e0e1e83702b08620149aa2d4fa599f6dd37 100644 --- a/docs/api/manual.md +++ b/docs/api/manual.md @@ -1,6 +1,6 @@ # Manual for wallet developers -This functionnal documentation presents how wallets can interact with the blockchain. +This functional documentation presents how wallets can interact with the blockchain. It is intended to complete the [runtime calls documentation](./runtime-calls.md) in a runtime-specific way to fit the real needs of wallet developers. Only ĞDev is covered for now. @@ -23,9 +23,9 @@ Only use `identity` pallet. The `membership` calls are disabled. ## Revoke an identity -Revoking an identity makes it lose its membership, hence UD creation and governance rights. Orher data such as balance will remain. +Revoking an identity makes it lose its membership, hence UD creation and governance rights. Other data such as balance will remain. -This feature is useful in case the user has lost their private key. +This feature is useful in case the user has lost their private key since the revocation document can be made in advance. ### Generate the revocation payload diff --git a/docs/dev/launch-a-live-network.md b/docs/dev/launch-a-live-network.md index 7b3a1f7b41041f300a821ba663d79bcb6661eb3e..12b21b365df7172810aa408b84f3426c08709e68 100644 --- a/docs/dev/launch-a-live-network.md +++ b/docs/dev/launch-a-live-network.md @@ -2,7 +2,7 @@ ## 1. Choose the currency type -Ensure that the currency type you want have the requirements. +Ensure that the currency type you want has the requirements. For now, only `gdev` is supported. diff --git a/docs/dev/weights-benchmarking.md b/docs/dev/weights-benchmarking.md index 6f7f3358edfd450701334d106495822e0676bacd..8d5b699d95fe8e8a4fae0521e7bff21abac5fc23 100644 --- a/docs/dev/weights-benchmarking.md +++ b/docs/dev/weights-benchmarking.md @@ -6,22 +6,22 @@ complete real example. `cargo test -p <pallet> --features runtime-benchmarks` 3. If the benchmark tests compiles and pass, compile the binary with benchmarks on your local machine: `cargo build --release --features runtime-benchmarks` -4. Run the benchmarks on your local machine (to test if it work mith a real runtime). The command +4. Run the benchmarks on your local machine (to test if it work with a real runtime). The command is: `duniter benchmark pallet --chain=CURRENCY-dev --steps=50 --repeat=20 --pallet=pallet_universal_dividend --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --header=./file_header.txt --output=.` -5. If it work, use the generated file content to create or update the `WeightInfo` trait and the `()` dummy implementation. Then use the `WeightInfo` tarit in the real code of the pallet. See 79e0fd4bf3b0579279fc957da5e2fdfc6d8a17fa for a +5. If it worked, use the generated file content to create or update the `WeightInfo` trait and the `()` dummy implementation. Then use the `WeightInfo` tarit in the real code of the pallet. See 79e0fd4bf3b0579279fc957da5e2fdfc6d8a17fa for a complete real example. 6. Redo steps `3.` and `4.` on the reference machine. 7. Put the generated file on `runtime/common/src/weights` and use it in the runtimes configuration. See cee7c3b2763ba402e807f126534d9cd39a8bd025 for a complete real example. -Note 1: You Must replace `CURRENCY` by the currency type, or for ĞDev use directly `--chain=dev`. +Note 1: You *must* replace `CURRENCY` by the currency type, or for ĞDev use directly `--chain=dev`. -Note2. If the reference machine not support wasmtime, you should replace `--wasm-execution=compiled` +Note 2: If the reference machine does not support wasmtime, you should replace `--wasm-execution=compiled` by `--wasm-execution=interpreted-i-know-what-i-do`. -## What the reference machine is? +## What is the reference machine? -For now (06/2022), it's a `Raspberry Pi 4 Model B - 4GB` with an SSD connected via USB3. +For now (09/2022), it's a `Raspberry Pi 4 Model B - 4GB` with an SSD connected via USB3. To cross-compile the benchmarks binary for armv7: diff --git a/docs/test/replay-block.md b/docs/test/replay-block.md index 14967ad19823b587bc340d2905687f04b0b02f06..607c555e8a0710c1b908d7b2b19c977733ddf359 100644 --- a/docs/test/replay-block.md +++ b/docs/test/replay-block.md @@ -1,6 +1,6 @@ # How to replay a block -You can use `try-runtime` subcommand to replay a block against a real satte from a live network. +You can use `try-runtime` subcommand to replay a block against a real state from a live network. 1. Checkout the git tag of the runtime version at the block you want to replay 2. Build duniter with feature `try-runtime`: `cargo build --features try-runtime` diff --git a/docs/user/smith.md b/docs/user/smith.md index 915bb52b35e7fe3b1dd4dec8d1956953484d8892..c6dc7281f20cc763db94bc58bd00524067ff5436 100644 --- a/docs/user/smith.md +++ b/docs/user/smith.md @@ -16,8 +16,9 @@ ### Reverse-proxy part (with Nginx) -In `/etc/nginx/sites-enabled/gdev.YOUR_DOMAIN` put (you can probably do simpler) : -``` +In `/etc/nginx/sites-enabled/gdev.YOUR_DOMAIN` put (you can probably do simpler): + +```nginx server { server_name gdev.YOUR_DOMAIN.fr; @@ -75,7 +76,7 @@ Your node is now online as a rpc node. It's fully capable for wallet use. - Send the query - Await smith certification : developer > extrinsics > CERTIFIER_SMITH_ACCOUNT > smithCert > addCert(receiver) -When you have at least 3 certifications, your'in ! +When you have at least 3 certifications, your'in! ## Validate blocks (blacksmith work) diff --git a/end2end-tests/README.md b/end2end-tests/README.md index 6bea5535161d2e486fc8cae70415ae783728139b..602883bfc79fc5f47b90ba0cfef2736c85a4a74d 100644 --- a/end2end-tests/README.md +++ b/end2end-tests/README.md @@ -1,6 +1,6 @@ # Duniter-v2s end2end tests -## Cucumber functionnal tests +## Cucumber functional tests We use [cucumber] to be able to describe test scenarios in human language.