Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[24 Jan 2025] - Add linters (shell, dockerfile, spell, etc.) #9

Open
1 of 4 tasks
BlaineEXE opened this issue Jan 24, 2025 · 1 comment
Open
1 of 4 tasks

[24 Jan 2025] - Add linters (shell, dockerfile, spell, etc.) #9

BlaineEXE opened this issue Jan 24, 2025 · 1 comment
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@BlaineEXE
Copy link
Contributor

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

@BlaineEXE BlaineEXE added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Jan 24, 2025
@carmal891
Copy link

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Development

No branches or pull requests

2 participants