From f3da299457f1073ffa276ad33f79743895747786 Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 14 Nov 2021 08:09:33 +0000 Subject: [PATCH] Format readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 987f7acf..41f388ea 100644 --- a/README.md +++ b/README.md @@ -67,13 +67,13 @@ To contribute to Headscale you would need the lastest version of [Go](https://go To ensure we have some consistency with a growing number of contributes, this project has adopted linting and style/formatting rules: -The **Go** code is linted with [`golangci-lint`](https://golangci-lint.run) and -formatted with [`golines`](https://github.com/segmentio/golines) (width 88) and +The **Go** code is linted with [`golangci-lint`](https://golangci-lint.run) and +formatted with [`golines`](https://github.com/segmentio/golines) (width 88) and [`gofumpt`](https://github.com/mvdan/gofumpt). -Please configure your editor to run the tools while developing and make sure to +Please configure your editor to run the tools while developing and make sure to run `make lint` and `make fmt` before committing any code. -The **Proto** code is linted with [`buf`](https://docs.buf.build/lint/overview) and +The **Proto** code is linted with [`buf`](https://docs.buf.build/lint/overview) and formatted with [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html). The **rest** (markdown, yaml, etc) is formatted with [`prettier`](https://prettier.io).