cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Add make lint to development environment section in Book (#4866)

Browse Source 
## Issue Addressed

We run `clippy` as part of our CI, so it would help new devs if we add the `make lint` command to the dev setup section in the Lighthouse book.
This commit is contained in:
Jimmy Chen 2023-10-20 06:23:29 +00:00
parent b11988223f
commit 8880675eda
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
book/src/setup.md
View File

@ -25,7 +25,8 @@ Commands to run the test suite are available via the `Makefile` in the
project root for the benefit of CI/CD. We list some of these commands below so project root for the benefit of CI/CD. We list some of these commands below so
you can run them locally and avoid CI failures: you can run them locally and avoid CI failures:
- `$ make cargo-fmt`: (fast) runs a Rust code linter. - `$ make cargo-fmt`: (fast) runs a Rust code formatting check.
- `$ make lint`: (fast) runs a Rust code linter.
- `$ make test`: (medium) runs unit tests across the whole project. - `$ make test`: (medium) runs unit tests across the whole project.
- `$ make test-ef`: (medium) runs the Ethereum Foundation test vectors. - `$ make test-ef`: (medium) runs the Ethereum Foundation test vectors.
- `$ make test-full`: (slow) runs the full test suite (including all previous - `$ make test-full`: (slow) runs the full test suite (including all previous