-
Notifications
You must be signed in to change notification settings - Fork 436
Style guidelines
Nick Ripley edited this page Jan 31, 2024
·
8 revisions
We try to follow a consistent style in this repository based on the common conventions for Go code.
First and foremost, Go code should be formatted with gofmt
.
For other matters like naming things, comments, or overall code structure, refer to the following guidelines:
- Effective Go
- Code Review Comments, which describes commonly encountered comments in order to avoid them.
We don't intend for reviewers to dogmatically enforce every one of the items in these guides. Rather, authors and reviewers should use these guidelines as tools to resolve disputes where style choices substantially affect the code in question.