Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 806 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 806 Bytes

Contributing

This project looks forward for your contribution in following areas.

Coding

To add a new command

This project uses Cobra for command implementations. To add a new command, check out its CLI tool.

Conventions

Any logic that's shared across commands should be coded under /common.

Static Code Analysis

This project uses golangci-lint and gofumpt.

If you use Visual Studio Code, make sure your settings.json includes

    "go.lintFlags": [
        "-D", "staticcheck", "-E", "gocyclo,gosec,makezero,prealloc,revive"
    ],
    "go.lintTool": "golangci-lint",
    "gopls": {
        "formatting.gofumpt": true
    },