Merge pull request #241 from ala-mode/docs_adjustment

docs adjustment

Author: AloeareV

Diff for: CONTRIBUTING.md

@@ -18,11 +18,17 @@ We welcome and appreciate contributions in the form of code, documentation, bug
 
 ## How to Contribute
 Code and documentation are very helpful and the lifeblood of Free Software. To merge in code to this repo, one will have to have a [GitHub account](https://docs.github.com/en/account-and-profile), and the ability to cryptographically verify commits against this identity. 
+
 The best way to verify is using a GPG signature. See [this document about commit signature verification.](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
+
 Code, being Rust, should be formatted using `rustfmt` and applying the `clippy` suggestions.
+
 Code should be as complex as it needs to be, but no more.
-All code will be reviewed in public, as conversations on the pull request. It is very possible there will be requested changed or questions. This is not a sign of disrespect, but needed to keep code quality high in an important piece of software in the Zcash ecosystem.
+
+All code will be reviewed in public, as conversations on the pull request. It is very possible there will be requested changes or questions. This is not a sign of disrespect, but is necessary to keep code quality high in an important piece of software in the Zcash ecosystem.
+
 Documentation should be clear and accurate to the latest commit on `dev`.
+
 These contributions must be [GitHub pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) opened _from a personal fork_ of the project, _to this repo, zingolabs/zaino_. Generally pull requests will be against `dev`, the development branch.
 
 ## Bug Reports and Feature Requests

Diff for: docs/testing.md

@@ -5,32 +5,37 @@
 3) [Zcashd, Zcash-Cli](https://github.com/zcash/zcash)
 
 ### Tests
-1) Simlink or copy compiled `zebrad`, zcashd` and `zcash-cli` binaries to `$ zaino/test_binaries/bins/*`
+1) Symlink or copy compiled `zebrad`, `zcashd` and `zcash-cli` binaries to `zaino/test_binaries/bins/*`
+
+**Chain Cache** _Several tests rely on a cached chain to run, for these tests to pass the chain must first be generated:_
 
-Chain Cache: Several tests rely on a cached chain to run, for these tests to pass the chain must first be generated:
 2) Generate the zcashd chain cache `cargo nextest run generate_zcashd_chain_cache --run-ignored ignored-only`
 3) Generate the zebrad chain cache `cargo nextest run generate_zebrad_large_chain_cache --run-ignored ignored-only`
 
-Client Rpc Tests: For the client rpc tests to pass a Zaino release binary must be built and added to PATH:
-4) Build release binary `cargo build --release` and add to PATH. WARNING: these tests do not use the binary built by cargo nextest
+**Client Rpc Tests** _For the client rpc tests to pass a Zaino release binary must be built and added to PATH.
+WARNING: these tests do not use the binary built by cargo nextest._
+
+4) Build release binary `cargo build --release` and add to PATH. For example, `export PATH=./target/release:$PATH` 
 
-5) Run `$ cargo nextest run`
+5) Run `cargo nextest run`
 
 NOTE: The client rpc get_subtree_roots tests are currently ignored, to run them testnet and mainnet chains must first be generated.
-- To run client rpc test `get_subtree_roots_sapling`:
+
+To run client rpc test `get_subtree_roots_sapling`:
 1) sync Zebrad testnet to at least 2 sapling shards
 2) copy the Zebrad testnet `state` cache to `zaino/integration-tests/chain_cache/get_subtree_roots_sapling` directory.
+
 See the `get_subtree_roots_sapling` test fixture doc comments in infrastructure for more details.
 
-- To run client rpc test `get_subtree_roots_orchard`:
+To run client rpc test `get_subtree_roots_orchard`:
 1) sync Zebrad mainnet to at least 2 orchard shards
 2) copy the Zebrad mainnet `state` cache to `zaino/integration-tests/chain_cache/get_subtree_roots_orchard` directory.
+
 See the `get_subtree_roots_orchard` test fixture doc comments in infrastructure for more details.
 
 - TESTNET TESTS:
-the testnet tests are temporary and will be replaced with regtest as soon as (https://github.com/zingolabs/zaino/issues/231) is resolved
-In the mean time, these tests can be ran, but it is a fiddly process. First, it needs a zebrad fully synced to testnet (depending
-on internet speed, etc., this could take 10+ hours). Then, the tests must be run 1 at a time (passing `--no-capture` will enforce this).
-Furthermore, due to https://github.com/zingolabs/infrastructure/issues/43, sometimes a zebrad will persist past the end of the test and
-hold a lock on the testnet cache, causing all remaining tests to fail. This process must be stopped manually, in order to allow testnet
-tests to work again.
+The testnet tests are temporary and will be replaced with regtest as soon as (https://github.com/zingolabs/zaino/issues/231) is resolved.
+In the mean time, these tests can be ran, but it is a fiddly process. First, it needs a zebrad fully synced to testnet (depending on internet speed, etc., this could take 10+ hours).
+To build the zebra testnet cache, the best way is to use zebra directly. With `zebrad` already in `$PATH` and from the `zaino/` directory run `zebrad --config ./zainod/zebrad.toml start`.
+Then, the tests must be run 1 at a time (passing `--no-capture` will enforce this).
+Furthermore, due to https://github.com/zingolabs/infrastructure/issues/43, sometimes a zebrad may persist past the end of the test and hold a lock on the testnet cache, causing remaining tests to fail. This process can be stopped manually, in order to allow testnet tests to work again.