CODE_STANDARDS.md

Code Standards

This project uses the following code standards and specifications from:

• effective go
• go benchmarks
• go examples
• go tests
• godoc
• gofmt
• golangci-lint
• report card

effective go standards

View the effective go standards documentation.

golangci-lint specifications

The package golangci-lint runs several linters in one package/cmd.

View the active linters in the configuration file.

Install via macOS:

brew install golangci-lint

Install via Linux and Windows:

# binary will be $(go env GOPATH)/bin/golangci-lint
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.31.0
golangci-lint --version

godoc specifications

All code is written with documentation in mind. Follow the best practices with naming, examples and function descriptions.