Skip to content

Commit

Permalink
Adds README content for goimports. (#24)
Browse files Browse the repository at this point in the history
Makes it clear that we use `goimports` for our style formatting
and provides some notes about how to go about setting this up
in one's dev environment.
  • Loading branch information
almann authored Feb 26, 2020
1 parent 5786577 commit 2bb6136
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ Running all the tests can be executed with:
$ go test -v ./...
```

We use [`goimports`](https://pkg.go.dev/golang.org/x/tools/cmd/goimports?tab=doc) to format
our imports and files in general. Running this before commit is advised:

```
$ goimports -w .
```

It is recommended that you hook this in your favorite IDE (`Tools` > `File Watchers` in Goland, for example).

## Notes

Expand Down

0 comments on commit 2bb6136

Please sign in to comment.