diff --git a/CODE_STYLE.md b/CODE_STYLE.md index 42a3a4b70..78dd0d367 100644 --- a/CODE_STYLE.md +++ b/CODE_STYLE.md @@ -1,6 +1,6 @@ # Code Style -We follow the standard Go style using gofmt, but with a few extra +We follow the standard Go style using goimports, but with a few extra considerations. ## Linters @@ -9,8 +9,8 @@ We use `golangci-lint` to run a number of linters, the exact list can be found u in [.golangci.yml](.golangci.yml). [Installation](https://github.com/golangci/golangci-lint#install) and [Editor Integration](https://github.com/golangci/golangci-lint#editor-integration) for it can be found in the readme of golangci-lint. For rare cases where a linter is giving a spurious warning, it can be disabled -for that line or statement using a [comment directive](https://github.com/alecthomas/gometalinter#comment-directives), e.g. -`// nolint: gocyclo`. This should be used sparingly and only when its clear +for that line or statement using a [comment directive](https://github.com/golangci/golangci-lint#nolint), e.g. +`var bad_name int //nolint:golint,unused`. This should be used sparingly and only when its clear that the lint warning is spurious. The linters can be run using [scripts/find-lint.sh](scripts/find-lint.sh)