Skip to content

Commit d29c4a7

Browse files
bhundvenactions-user
authored andcommitted
chore: Update README.md for release
1 parent 6030b63 commit d29c4a7

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# golang-pre-commit
2+
3+
This is a collection of golang [pre-commit](http://pre-commit.com/) hooks.
4+
## Usage
5+
6+
```yaml
7+
- repo: https://github.com/bhundven/golang-pre-commit.git
8+
rev: v1.0.0
9+
hooks:
10+
```
11+
12+
## Available Hooks
13+
14+
* `go-fmt` - Runs `gofmt`. Requires golang
15+
* `go-imports` - Runs `goimports`. Requires golang and goimports
16+
* `go-vet` - Runs `go vet`. Requires golang
17+
* `go-lint` - Runs `golint`. Requires golang and golint
18+
* `golangci-lint` - Runs `golangci-lint`. Requires golangci-lint
19+
* `go-critic` - Runs `gocritic`. Requires gocritic
20+
* `go-unit-tests` - Runs `go test`
21+
* `go-build` - Runs `go build`
22+
* `go-generate` - Runs `go generate`
23+
* `go-mod-tidy` - Runs `go mod tidy -v`
24+
* `go-mod-vendor` - Runs `go mod vendor`

0 commit comments

Comments
 (0)