cosmos-sdk/contrib/githooks/README.md

22 lines
518 B
Markdown
Raw Normal View History

# Git hooks
Installation:
```
$ git config core.hooksPath contrib/githooks
```
## pre-commit
The hook automatically runs `gofmt`, `goimports`, and `misspell`
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:
```
$ go get golang.org/x/tools/cmd/goimports
$ go get github.com/golangci/misspell/cmd/misspell@master
```
It also runs `go mod tidy` and `golangci-lint` if available.