CONTRIBUTING.md

Contributing

Linters

This project uses a set of linters to ensure good code quality. In order to make proper use of those linters inside an IDE, the following configuration is required.

Further information can also be found in the golangci-lint documentation.

Visual Studio Code

In Visual Studio Code the Golang extension is required.

Adding the following lines to the Golang extension configuration file will enable all linters used in this project.

"go.lintTool": {
	"type": "string",
	"default": "golangci-lint",
	"description": "GolangGCI Linter",
	"scope": "resource",
	"enum": [
		"golangci-lint",
	]
},
"go.lintFlags": {
	"type": "array",
	"items": {
		"type": "string"
	},
	"default": ["--fast", "--fix"],
	"description": "Flags to pass to GCI Linter",
	"scope": "resource"
},

GoLand / IntelliJ

In GoLand or IntelliJ, the plugin Go Linter will be required.

The plugin can be installed via Settings >> Plugins >> Marketplace, search for Go Linter and install it. Once installed, make sure that the plugin is using the .golangci.yml file from the root directory.

The configuration of Go Linter can be found in the Tools section of the settings.