diff --git a/README.md b/README.md index 92c8a50cf..53a40663a 100644 --- a/README.md +++ b/README.md @@ -95,14 +95,14 @@ Follow these steps to set up a functional development environment: 1. Install Docker Desktop. 2. Run `make install-go-tools`. 3. Run `make install-pre-commit`. -4. Run `pre-commit install --install-hooks` in the repo root directory. -5. Create a PGP key pair and [add the public key to Github](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). -6. Configure Git: -``` +4. Create a PGP key pair and [add the public key to Github](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account). +5. Configure Git. Please note that signing commits is required to merge a PR, and length 7 commit abbreviation is required to run `make build-docker` locally. + +```bash git config --local user.name git config --local user.email -git config --local core.abbrev 7 -git config --local commit.gpgsign true +git config --local core.abbrev 7 # align short commits +git config --local commit.gpgsign true # sign commits ``` ## Security diff --git a/docs/content/build/1-quickstart.md b/docs/content/build/1-quickstart.md index 29d1283d0..352aaf87d 100644 --- a/docs/content/build/1-quickstart.md +++ b/docs/content/build/1-quickstart.md @@ -126,7 +126,7 @@ echo $CONTROLLER # XStakeController contract address on Omni EVM ### 5. Try it out -Setup env. +Setup environment. ```bash source deployments.sh @@ -143,7 +143,7 @@ cast send $OP_TOKEN "approve(address,uint256)" $OP_XSTAKER 100 --rpc-url $OP_R Calculate xcall fee. ```bash -cast call $OP_XSTAKER "stakeFee(uint256)(uint256)" 100 --rpc-url $OP_RCP +cast call $OP_XSTAKER "stakeFee(uint256)(uint256)" 100 --rpc-url $OP_RPC ```