From 1c238dd724158e2e35da892958975df4d6602fa0 Mon Sep 17 00:00:00 2001 From: Matt Alexander Date: Fri, 29 Oct 2021 16:14:04 -0500 Subject: [PATCH] fix(docs): Add reference to `make lint` in section talking about `go fmt`. --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9b2803..48e92fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,6 +70,9 @@ All code should be formatted through `go fmt`. This tool will automatically format code for you. We recommend, however, that you write code in the proper style and use `go fmt` only to catch mistakes. +`make lint` will check your code against `go fmt`. You may need to install +[`golangci-lint`] as a dependency. + Use [pre-commit](https://pre-commit.com/) to validate your commits against the various linters configured for this repository. @@ -77,3 +80,5 @@ linters configured for this repository. Run `make test` to test Yay. This command will verify that the code is formatted correctly, run the code through `go vet`, and run unit tests. + +[`golangci-lint`]: https://github.com/golangci/golangci-lint \ No newline at end of file