feat: Create common golangci-lint config

[walldiss]

Introduce common golangci-lint config that can be reused across celestiaorg repos. The list of suggested linters is based on what is currently used in https://github.com/celestiaorg/celestia-node. Feel free to suggest linters to include / exclude.

[MSevey]

are you thinking this will be a reference file or that you want a common reuseable workflow to call this file?

[walldiss]

I'm thinking it could be a good reference for others to follow the rules we found useful in Node. It can be imported optionally, but I would suggest making a local copy in case the config needs to be modified in accordance with local contextual requirements.

[cristaloleg]

Let's sort enabled checks please.

[cristaloleg]

Plus

  nakedret:
    # No naked returns, ever.
    max-func-lines: 1

[cristaloleg]

Based on https://olegk.dev/go-linters-configuration-the-right-version (shameless plug):

output:
  # Must have. Easier to understand the output.
  print-linter-name: true

  # No, no skips, everything should be reported.
  uniq-by-line: false

  # To be honest no idea when this can be needed, maybe a multi-module setup?
  path-prefix: ""

  # Slightly easier to follow the results + getting deterministic output.
  sort-results: true

[cristaloleg]

Based on https://olegk.dev/go-linters-configuration-the-right-version (shameless plug):

issues:
  # I found it strange to skip the errors, setting 0 to have all the results.
  max-issues-per-linter: 0

  # Same here, nothing should be skipped to not miss errors.
  max-same-issues: 0

[cristaloleg]

Plus:

  # This is very important, bugs in tests are not acceptable either.
  tests: true

  # With the read-only mode linter will fail if go.mod file is outdated.
  modules-download-mode: readonly

  # Keep this empty to use the Go version from the go.mod file.
  go: ""