Add linters (shell, dockerfile, spell, etc.) #9
Description
Enhancement
Is your feature request related to a problem?/Why is this needed
Add linters (and integrate with Prow CI) that ensure COSI code quality.
Describe the solution you'd like in detail
Linters that would be good for the COSI repo to run:
- golangci-lint (done)
- bash script checks with shellcheck
- dockerfile linting - hadolint?
- basic spell checking - cspell?
When adding linters, it would be best to add them one-by-one to help with review.
This is an area where community contributions could be easy and helpful since these aren't quite as high priority as our current (first half 2025) priorities of building out E2E testing and focusing on v1alpha2 and eventual v1beta1.
Linters should run with make lint and not have a separate make target. This will ensure that new COSI contributors aren't confused by a massive make help text unnecessarily. If a particular linter is taking a long time to run, we can discuss having a separate target for it as needed.
Describe alternatives you've considered
I tried this with megalinter and got feedback that megalinter is challenging to coordinate between user dev envs: https://github.com/kubernetes-retired/container-object-storage-interface-api/pull/98/files
This abandoned PR will likely be a good reference for helping to configure individual linters to keep from repeating work that has already been done.
Additional context
N/A