Skip to content

Commit

Permalink
docs: add style recommendations to Code Guidelines
Browse files Browse the repository at this point in the history
Require that code be formatting using `gofmt` and `goimports`. Suggest
that code be formatted using `golines`.

Signed-off-by: Link Dupont <link@sub-pop.net>
  • Loading branch information
subpop committed Jul 18, 2023
1 parent b51d92b commit f29f6eb
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,11 @@ echo -n "hello" | yggctl dispatch -w "echo" -
exclusively.
* Code can exist in a package if it provides an alternative interface to
another package, and the two packages cannot be imported together.
* Code should be formatted using `gofmt` and `goimports` before committing. As
the saying goes ["gofmt's style is no one's favorite, yet gofmt is everyone's
favorite."](https://www.youtube.com/watch?v=PAAkCSZUG1c&t=8m43s).
* Code may optionally be formatted using
[`golines`](https://github.com/segmentio/golines), to wrap long lines.

## Required Reading

Expand Down

0 comments on commit f29f6eb

Please sign in to comment.