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

docs: improve linter/rule/check docs #5036

Merged
merged 5 commits into from
Sep 23, 2024

Conversation

ldez
Copy link
Member

@ldez ldez commented Sep 22, 2024

It's verbose but it's easier to find if a linter already implements a rule.

It's not perfect, but it's good enough for now.

  • govet: add descriptions for all passes.
  • gocritic: add descriptions for all checks.
  • staticcheck/stylecheck/gosimple: add description for all analyzers.
  • promlinter: add descriptions for all rules.

@ldez ldez added enhancement New feature or improvement area: docs labels Sep 22, 2024
@ldez ldez added this to the next milestone Sep 22, 2024
@Antonboom
Copy link
Contributor

We definitely need checkboxes in PR like "please grep gocritic, revive, staticcheck, govet", "be sure that it cannot be implemented by ruleguard and forbidigo" 🙂

@ldez ldez merged commit 2e88c4e into golangci:master Sep 23, 2024
16 checks passed
@ldez ldez deleted the feat/improve-linter-docs branch September 23, 2024 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants