docs: Improve markdownlint configuration (#11104)
## Description Closes: #9404 --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
Installation:
|
||||
|
||||
```
|
||||
```sh
|
||||
git config core.hooksPath contrib/githooks
|
||||
```
|
||||
|
||||
@@ -13,7 +13,7 @@ to correctly format the `.go` files included in the commit, provided
|
||||
that all the aforementioned commands are installed and available
|
||||
in the user's search `$PATH` environment variable:
|
||||
|
||||
```
|
||||
```sh
|
||||
go get golang.org/x/tools/cmd/goimports
|
||||
go get github.com/golangci/misspell/cmd/misspell@master
|
||||
```
|
||||
|
||||
@@ -15,14 +15,17 @@ Both `simd-env` and `simd-dlv` work and run the same, except that `simd-dlv` use
|
||||
## How to use
|
||||
|
||||
The command to start a local network in debug mode is:
|
||||
|
||||
```shell
|
||||
# make localnet-debug
|
||||
```
|
||||
|
||||
The command to stop the local network and destroy its containers is:
|
||||
|
||||
```shell
|
||||
# make localnet-stop
|
||||
```
|
||||
|
||||
__note: this works the same for both `localnet-start` and `localnet-debug`__
|
||||
|
||||
Now, by default only `simdnode0` is run in debug mode, but you can run any of the other nodes in debug mode by changing the `DEBUG` environment variable to `1` in `docker-compose.yml`.
|
||||
|
||||
@@ -6,10 +6,10 @@ This directory contains the files required to run the rosetta CI. It builds `sim
|
||||
|
||||
Builds:
|
||||
|
||||
- cosmos-sdk simapp node, with prefixed data directory, keys etc. This is required to test historical balances.
|
||||
- faucet is required so we can test construction API, it was literally impossible to put there a deterministic address to request funds for
|
||||
- rosetta is the rosetta node used by rosetta-cli to interact with the cosmos-sdk app
|
||||
- test_rosetta runs the rosetta-cli test against construction API and data API
|
||||
* cosmos-sdk simapp node, with prefixed data directory, keys etc. This is required to test historical balances.
|
||||
* faucet is required so we can test construction API, it was literally impossible to put there a deterministic address to request funds for
|
||||
* rosetta is the rosetta node used by rosetta-cli to interact with the cosmos-sdk app
|
||||
* test_rosetta runs the rosetta-cli test against construction API and data API
|
||||
|
||||
## configuration
|
||||
|
||||
@@ -25,5 +25,5 @@ The docker image for ./rosetta-cli/Dockerfile is on [docker hub](https://hub.doc
|
||||
|
||||
## Notes
|
||||
|
||||
- Keyring password is 12345678
|
||||
- data.sh creates node data, it's required in case consensus breaking changes are made to quickly recreate replicable node data for rosetta
|
||||
* Keyring password is 12345678
|
||||
* data.sh creates node data, it's required in case consensus breaking changes are made to quickly recreate replicable node data for rosetta
|
||||
|
||||
Reference in New Issue
Block a user