Skip to content

Commit ef47262

Browse files
jeremyederclaude
andauthored
chore: streamline CodeRabbit config to only non-default values (#142)
Reduced configuration from 240 to 156 lines by removing all default values. Config now only specifies deviations from schema defaults, making it clearer what's actually customized. Changes: - Removed redundant default values (language: en-US, profile: chill, etc.) - Kept only 7 customizations: poem off, request changes on, tool disables, path instructions, path filters, knowledge base, tone - Validated against schema.v2.json to ensure accuracy Benefits: - Easier to understand what's actually configured - Less maintenance when schema updates - Clearer signal-to-noise intent 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 96cee41 commit ef47262

File tree

1 file changed

+81
-168
lines changed

1 file changed

+81
-168
lines changed

.coderabbit.yaml

Lines changed: 81 additions & 168 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,31 @@
11
# CodeRabbit Configuration for AgentReady
2-
# Goal: Extremely high signal-to-noise ratio for AI code reviews
3-
# Last Updated: 2025-11-25
2+
# Only non-default values specified for maximum clarity
3+
# Full schema: https://coderabbit.ai/integrations/schema.v2.json
44

5-
# Language and tone settings
6-
language: en-US
7-
early_access: false
8-
enable_free_tier: true
9-
10-
# Review behavior - optimized for signal
5+
# Disable poems (default: true)
116
reviews:
12-
# Use "chill" profile to reduce noise
13-
profile: "chill"
14-
15-
# Request changes only for critical issues
16-
request_changes_workflow: true
17-
18-
# High-level overview without verbose walkthrough
19-
high_level_summary: true
20-
high_level_summary_placeholder: "<!-- CODERABBIT SUMMARY -->"
21-
22-
# Disable poem (pure noise)
237
poem: false
248

25-
# Collapse walkthrough to reduce visual clutter
26-
collapse_walkthrough: true
27-
28-
# Review status at top of PR for quick scanning
29-
review_status: true
30-
31-
# Auto-review configuration
32-
auto_review:
33-
enabled: true
34-
drafts: false # Don't waste cycles on WIP
35-
base_branches:
36-
- main
9+
# Request changes for critical issues (default: false)
10+
request_changes_workflow: true
3711

38-
# Tools configuration - only high-signal checks
12+
# Disable tools we run locally to reduce noise
3913
tools:
40-
# Linting tools (we already run these locally, skip duplicates)
14+
# Python formatting/linting (we run locally before push)
4115
ruff:
42-
enabled: false # We run ruff locally before push
43-
black:
44-
enabled: false # We run black locally before push
45-
isort:
46-
enabled: false # We run isort locally before push
47-
48-
# GitHub Actions analysis (useful for CI/CD changes)
49-
actionlint:
50-
enabled: true
51-
52-
# Shellcheck for bash scripts
53-
shellcheck:
54-
enabled: true
16+
enabled: false # default: true
17+
flake8:
18+
enabled: false # default: true
19+
pylint:
20+
enabled: false # default: true
5521

56-
# Markdownlint (we run locally but good backup)
57-
markdownlint:
58-
enabled: true
59-
60-
# Gitleaks for secret detection (high signal)
61-
gitleaks:
62-
enabled: true
63-
64-
# Biome (JavaScript/TypeScript - not applicable but harmless)
22+
# We don't use these technologies
6523
biome:
66-
enabled: false
67-
68-
# Hadolint for Dockerfiles (future use)
69-
hadolint:
70-
enabled: true
71-
72-
# What to focus on (HIGH SIGNAL ONLY)
73-
focus:
74-
- security_vulnerabilities # Critical: SQL injection, XSS, etc.
75-
- bug_risks # High: Logic errors, race conditions
76-
- error_handling # High: Uncaught exceptions, poor error messages
77-
- breaking_changes # High: API compatibility
78-
- performance_issues # Medium: Only significant issues (O(n²) → O(n))
79-
- test_coverage_gaps # Medium: Missing critical test cases
80-
- documentation_gaps # Low: Only for public APIs and complex logic
81-
82-
# What to ignore (NOISE REDUCTION)
83-
ignore:
84-
- style_preferences # Handled by black/isort/ruff locally
85-
- naming_conventions # Handled by ruff locally
86-
- line_length # We explicitly don't enforce this
87-
- minor_refactoring_suggestions # Only suggest if major impact
88-
- subjective_improvements # "This could be cleaner" noise
89-
- trivial_optimizations # Micro-optimizations with no real impact
90-
91-
# Severity thresholds - only comment on important issues
92-
severity_threshold: "medium" # Skip "low" severity comments
93-
94-
# Path-based rules
24+
enabled: false # default: true (JS/TS tool, not applicable)
25+
26+
# Path-specific review instructions
9527
path_instructions:
96-
# Core library code - highest scrutiny
28+
# Core assessors - enforce patterns
9729
- path: "src/agentready/assessors/**"
9830
instructions: |
9931
- Verify BaseAssessor pattern compliance
@@ -102,132 +34,113 @@ reviews:
10234
- Validate attribute_id matches research report
10335
- Check for graceful degradation when tools missing
10436
37+
# Data models - check for breaking changes
10538
- path: "src/agentready/models/**"
10639
instructions: |
10740
- Check for breaking changes to data models
10841
- Verify backwards compatibility
10942
- Ensure schema version bumps when needed
11043
44+
# Services - security and performance focus
11145
- path: "src/agentready/services/**"
11246
instructions: |
11347
- Check for proper error handling
11448
- Verify performance implications (file I/O, subprocess calls)
11549
- Look for security issues (path traversal, command injection)
11650
117-
# Tests - focus on coverage and correctness
51+
# Tests - coverage and correctness only
11852
- path: "tests/**"
11953
instructions: |
12054
- Verify test actually tests the intended behavior
12155
- Check for missing edge cases
12256
- Flag overly brittle tests (mocking too much)
123-
- Skip style comments entirely
57+
- Skip all style comments
12458
125-
# CLI - focus on UX and error messages
59+
# CLI - UX and error messages
12660
- path: "src/agentready/cli/**"
12761
instructions: |
12862
- Check for clear error messages
12963
- Verify help text is accurate
13064
- Look for missing error handling for user input
13165
132-
# GitHub workflows - focus on security and correctness
66+
# GitHub Actions - security focus
13367
- path: ".github/workflows/**"
13468
instructions: |
13569
- Check for secret exposure risks
13670
- Verify proper permissions (least privilege)
13771
- Flag outdated action versions (security)
13872
139-
# Documentation - only flag critical issues
73+
# Documentation - critical issues only
14074
- path: "**/*.md"
14175
instructions: |
14276
- Only comment on factual errors or broken links
14377
- Skip formatting/style suggestions
14478
- Flag outdated information (version mismatches, wrong commands)
14579
146-
# Scripts - focus on security and robustness
80+
# Scripts - security and robustness
14781
- path: "scripts/**"
14882
instructions: |
14983
- Check for command injection vulnerabilities
15084
- Verify error handling for subprocess calls
15185
- Flag missing input validation
15286
153-
# Path filters - completely skip reviewing these
154-
path_filters:
155-
# Build artifacts and caches
156-
- "!**/*.pyc"
157-
- "!**/__pycache__/**"
158-
- "!.venv/**"
159-
- "!venv/**"
160-
- "!htmlcov/**"
161-
- "!.pytest_cache/**"
162-
- "!.ruff_cache/**"
163-
- "!*.egg-info/**"
164-
- "!build/**"
165-
- "!dist/**"
166-
167-
# Generated reports and data
168-
- "!.agentready/**"
169-
- "!.cache/**"
170-
- "!*.log"
171-
- "!*.tmp"
172-
173-
# Lock files (dependency updates are separate concern)
174-
- "!uv.lock"
175-
- "!poetry.lock"
176-
- "!package-lock.json"
177-
178-
# Example outputs (reference only, not production code)
179-
- "!examples/**/*.json"
180-
- "!examples/**/*.html"
181-
- "!examples/**/*.md"
182-
183-
# Custom instructions - AgentReady-specific context
184-
chat:
185-
auto_reply: true
186-
187-
# Knowledge base - teach CodeRabbit about AgentReady patterns
87+
# Skip reviewing these paths entirely
88+
path_filters:
89+
- "!**/*.pyc"
90+
- "!**/__pycache__/**"
91+
- "!.venv/**"
92+
- "!venv/**"
93+
- "!htmlcov/**"
94+
- "!.pytest_cache/**"
95+
- "!.ruff_cache/**"
96+
- "!*.egg-info/**"
97+
- "!build/**"
98+
- "!dist/**"
99+
- "!.agentready/**"
100+
- "!.cache/**"
101+
- "!*.log"
102+
- "!*.tmp"
103+
- "!uv.lock"
104+
- "!poetry.lock"
105+
- "!package-lock.json"
106+
- "!examples/**/*.json"
107+
- "!examples/**/*.html"
108+
- "!examples/**/*.md"
109+
110+
# Teach CodeRabbit about AgentReady-specific patterns
188111
knowledge_base:
189-
- |
190-
AgentReady is a tool that assesses repositories against 25 agent-ready best practices.
191-
The research report (agent-ready-codebase-attributes.md) defines these attributes.
192-
All assessors must inherit from BaseAssessor and implement attribute_id property and assess() method.
193-
194-
- |
195-
We intentionally don't enforce line length limits (E501 ignored in ruff).
196-
We use black for formatting with default settings.
197-
We prefer explicit over clever, simple over complex.
198-
199-
- |
200-
Error handling philosophy: Assessors should return Finding.create_skipped() when tools are missing,
201-
not crash. Fail gracefully and provide actionable remediation guidance.
202-
203-
- |
204-
This project follows conventional commits (feat:, fix:, chore:, docs:, test:, refactor:).
205-
All commits should be squashed before merge.
206-
All commits must be signed with git signature.
207-
208-
- |
209-
Testing philosophy: We aim for >80% coverage on new code.
210-
Tests should focus on behavior, not implementation details.
211-
Mock external dependencies, but don't over-mock internal functions.
212-
213-
- |
214-
Documentation: CLAUDE.md is the source of truth for development.
215-
README.md is user-facing. Keep them in sync.
216-
All new features must update CLAUDE.md before merging.
217-
218-
# Review thresholds - only create review comments for actionable items
219-
review:
220-
# Minimum confidence to comment (0.0 - 1.0)
221-
# Higher = fewer but more accurate comments
222-
confidence_threshold: 0.75
223-
224-
# Require at least this many similar patterns before suggesting refactoring
225-
pattern_threshold: 3
226-
227-
# Only suggest performance improvements if >10% impact
228-
performance_improvement_threshold: 0.10
229-
230-
# Tone and style - professional and concise
112+
code_guidelines:
113+
# Custom guidelines (default has empty array)
114+
learnings:
115+
- |
116+
AgentReady assesses repositories against 25 agent-ready best practices.
117+
Research report (agent-ready-codebase-attributes.md) defines these attributes.
118+
All assessors must inherit from BaseAssessor and implement attribute_id and assess().
119+
120+
- |
121+
We intentionally don't enforce line length (E501 ignored in ruff).
122+
We use black for formatting with defaults.
123+
Prefer explicit over clever, simple over complex.
124+
125+
- |
126+
Error handling: Assessors return Finding.create_skipped() when tools missing, not crash.
127+
Fail gracefully and provide actionable remediation guidance.
128+
129+
- |
130+
Conventional commits (feat:, fix:, chore:, docs:, test:, refactor:).
131+
All commits squashed before merge and signed with git signature.
132+
133+
- |
134+
Target >80% test coverage on new code.
135+
Tests focus on behavior, not implementation.
136+
Mock external dependencies, don't over-mock internals.
137+
138+
- |
139+
CLAUDE.md is source of truth for development.
140+
README.md is user-facing.
141+
All new features must update CLAUDE.md before merging.
142+
143+
# Professional, concise tone (default: "")
231144
tone_instructions: |
232145
- Be direct and concise - no fluff or pleasantries
233146
- Focus on "why" not just "what" (explain the impact)

0 commit comments

Comments
 (0)