chore: add CodeRabbit configuration tuned to project guidelines - #48
Conversation
|
Warning Review limit reached
Next review available in: 51 minutes Limit details: You’ve used all 3 included reviews currently available. Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Comment |
There was a problem hiding this comment.
Pull request overview
Adds a repository-specific CodeRabbit configuration so automated reviews follow this project’s conventions (Rust/MSRV, benchmark integrity, docs tone, and workflow expectations) instead of generic defaults.
Changes:
- Adds
.coderabbit.yamlwith an assertive review profile and request-changes workflow. - Configures path-specific instructions (retrieval, crates, docs, workflows, eval) and enables integrated linters (actionlint/shellcheck/markdownlint/ruff).
- Disables docstring and unit-test generation to reduce churn and align with minimal-LOC guidance.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Docs must follow the repo's documentation rules: no em-dashes in user-facing docs, no hedging or banned words (comprehensive, robust, seamless, leverage, utilize, facilitate, empower, cutting-edge, state-of-the-art, holistic), one fact in exactly one place, and docs must be updated in the same PR as the behavior they describe. Flag stale claims (test counts, version numbers) that contradict code. | ||
| - path: ".github/workflows/**" | ||
| instructions: | | ||
| This repo runs CI on Blacksmith runners (blacksmith-* labels; see .github/actionlint.yaml). Do not flag blacksmith-* runner labels as unknown. Release workflows must preserve the 6 Rust targets and archive names vera-<target>.(tar.gz|zip). |
Tunes CodeRabbit to this repo instead of running it with generic defaults.
retrieval/**(mechanism rationale + Semble verification for ranking changes), minimal-LOC/no-duplication Rust conventions forcrates/**, docs tone/freshness rules for*.md, Blacksmith runner awareness for workflows, benchmark-harness integrity foreval/**.Validated against the published v2 JSON schema (keys + types) and yaml.safe_load.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Summary by cubic
Adds a project-specific
.coderabbit.yamlso CodeRabbit enforces our repo rules instead of generic defaults. Reviews switch to an assertive, request-changes workflow with integrated linters; auto-generation of docstrings and unit tests is disabled to avoid churn.crates/vera-core/src/retrieval/**: require mechanism-level rationale for ranking changes and Semble benchmark verification.crates/**: Rust conventions (edition 2024, MSRV 1.85,anyhow::Resultfor CLI,thiserrorin core,tracing, tests in#[cfg(test)]at file end).**/*.md: docs tone/freshness rules and single-source-of-truth..github/workflows/**: allow Blacksmith runner labels and preserve release targets andvera-<target>.(tar.gz|zip)archives.eval/**: keep benchmark harness integrity; metrics consistent withbenchmarks/scripts/bench_common.py.actionlint,shellcheck,markdownlint,ruff.Written for commit 83fff87. Summary will update on new commits.