From 8880675eda5c2623ba480506f5980f6836be1c31 Mon Sep 17 00:00:00 2001 From: Jimmy Chen Date: Fri, 20 Oct 2023 06:23:29 +0000 Subject: [PATCH] Add `make lint` to development environment section in Book (#4866) ## 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. --- book/src/setup.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/book/src/setup.md b/book/src/setup.md index d7eafbdf9..87f431f9b 100644 --- a/book/src/setup.md +++ b/book/src/setup.md @@ -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 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-ef`: (medium) runs the Ethereum Foundation test vectors. - `$ make test-full`: (slow) runs the full test suite (including all previous