nlnwa / go_container Goto Github PK

Motivation

If some of the most obvious spelling mistakes and word order issues were solved before a pull request was created, pull request reviews would go much smoother. This leads to less "noise" in pull requests

Feature

By using tools such as https://github.com/streetsidesoftware/cspell we can avoid some of the worst spelling mistakes, and perhaps other tools can be used to lint for grammar mistakes.

Motivation

If others want to contribute code to our repositories, we need to have to make sure we have the necessary legal rights to the code, otherwise changing licenses, etc could be legally dubious.

Feature

Add a CONTRIBUTING.md file that contains how to contribute, with a Contributor Licence Agreement that must be signed before contributing. An option is to base it on grpc-go contributing guidelines: https://github.com/grpc/grpc-go/blob/master/CONTRIBUTING.md

The current sub-linters are now enabled (or soon to be):

The default enabled sub-linters as of version v1.53.3:

• errcheck
• gosimple
• govet
• ineffassign
• staticcheck
• typecheck
• unused

The default disabled sub-linters as of version v1.53.3:

• gofmt, to ensure all code has been formatted properly

There still remains a large list of sub-linters that we have not taken a stand on, which can be found here: https://golangci-lint.run/usage/linters/