Skip to content

Commit cd0293a

Browse files
committed
CONTRIBUTING: add gofumpt formatter note
Document the formatter we use. Signed-off-by: Paul Holzinger <pholzing@redhat.com>
1 parent 5c1ed12 commit cd0293a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,8 @@ It is not necessary to test a single change in multiple places.
146146

147147
### Go Format and lint
148148

149-
All code changes must pass ``make validatepr``.
149+
All code changes must pass `make validatepr`.
150+
We are using the [`gofumpt`](https://github.com/mvdan/gofumpt) formatter for our go code, you can either use it directly or format via `golangci-lint fmt`. The `validatepr`/`validate` make targets will fail if the code is not formatted correctly.
150151

151152
### Integration Tests
152153

0 commit comments

Comments
 (0)