docs: Add golangci-lint version support and v2 integration guidance

[devdattatalele]

Summary

This PR addresses issue #406 by adding comprehensive documentation about golangci-lint version support and integration guidance.

Changes Made

Added to docs/tools/golangci-lint.md:

1. Supported Versions Section

   • Clarifies that CodeRabbit supports golangci-lint v1.x
   • Explains potential issues with v2.x usage

2. Configuration Section

   • Documents all supported configuration file formats
   • Explains automatic detection behavior

3. Integration Workaround Section

   • Provides practical guidance for using v1 alongside v2
   • Offers alternative approaches for strict v2 requirements

Fixes

• Resolves confusion about golangci-lint version compatibility
• Provides clear documentation for users experiencing v2 warnings
• Offers practical workarounds for mixed-version environments

Closes #406

Summary by CodeRabbit

• Documentation
  • Expanded GolangCI-Lint guide with supported versions (v1.x supported; v2.x caveats).
  • Clarified configuration discovery and auto-detection by the platform.
  • Added option to specify a custom config via project settings.
  • Documented steps to run v1-compatible linting alongside v2 as a workaround.
  • Updated features overview to highlight common issue detection.
  • Included reference links for configuration and usage.

[coderabbitai]

Caution

Review failed

Failed to post review comments.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3e91e5 and e5c1448.

📒 Files selected for processing (1)

• docs/tools/golangci-lint.md (1 hunks)

📝 Walkthrough

Walkthrough

The docs file docs/tools/golangci-lint.md was expanded and reorganized to document supported golangci-lint v1.x, configuration discovery and custom config settings, and a v1-v2 coexistence workaround; links were updated. No code logic changes.

Changes

Cohort / File(s)	Summary
Documentation: golangci-lint guide docs/tools/golangci-lint.md	Rewrote and expanded guide: added "Supported Versions" (v1.x) and v2 caveats, configuration discovery and supported config filenames, user-configurable path via reviews.tools.golangci-lint.config_file in .coderabbit.yaml/settings, steps to integrate v1 alongside v2, generalized feature list, and updated links.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Document supported version (v1.x) and clarify lack of v2 support [#406]	✅
Provide options/workaround for using v1 alongside v2 configurations [#406]	✅
Correct documentation links to appropriate configuration docs, avoid v2-only references [#406]	✅
Describe how to set a custom config file via CodeRabbit settings/.coderabbit.yaml [#406]	✅

Poem

I nibble docs and tidy each line,
A rabbit of lint, with guidance divine.
V1 on the shelf, while v2 takes a nap,
Two configs can dance — a tidy overlap.
Hoppity-hop, clean code on the map! 🐇✨

Pre-Merge Checks (5 passed)

✅ Passed Checks (5 passed)

Check Name	Status	Explanation
Title Check	✅ Passed	The title clearly describes the documentation changes for golangci-lint version support and v2 integration guidance, matching the scope of the PR.
Description Check	✅ Passed	The description provides a clear summary, lists the changes in detail, and links to the issue, offering sufficient context; consider adding a pull request template to standardize future PR descriptions.
Linked Issues Assessment	✅ Passed	The documentation now identifies supported v1.x, corrects the v2+ config link, lists supported config formats, explains behavior with v2 configs, and provides integration workarounds, fully addressing the objectives of issue #406.
Out-of-scope Changes Assessment	✅ Passed	All changes are focused on docs/tools/golangci-lint.md and directly relate to version support and integration guidance, with no unrelated modifications.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[devdattatalele]

@coderabbit-amank full review

[coderabbitai]

@devdattatalele I'll conduct a full review of the PR changes for the golangci-lint documentation.

✅ Actions performed

Full review triggered.