SKILL.md
CodeRabbit Core Workflow A: Automated PR Review
Overview
The primary CodeRabbit workflow: a developer opens a PR, CodeRabbit automatically analyzes the diff, posts a walkthrough summary and line-level comments, and the developer addresses feedback. This skill covers configuration, review profiles, path instructions, and the full review lifecycle.
Prerequisites
- CodeRabbit GitHub App installed (see
coderabbit-install-auth) .coderabbit.yamlin repository root- At least one PR-capable branch
Instructions
Step 1: Configure the Review Pipeline
# .coderabbit.yaml - Production-ready configuration
language: "en-US"
early_access: false
reviews:
profile: "assertive" # chill = less feedback, assertive = more thorough
request_changes_workflow: true # CodeRabbit marks review as "changes requested" for issues
high_level_summary: true # Post a walkthrough comment summarizing all changes
high_level_summary_in_walkthrough: true
review_status: true # Show review progress status
collapse_walkthrough: false # Keep walkthrough expanded
sequence_diagrams: true # Generate control flow diagrams
poem: false # Disable poems in review summary
auto_review:
enabled: true
drafts: false # Skip draft PRs
base_branches:
- main
- develop
ignore_title_keywords:
- "WIP"
- "DO NOT MERGE"
- "chore: bump"
path_filters:
- "!**/*.lock"
- "!**/*.snap"
- "!**/generated/**"
- "!dist/**"
- "!**/*.min.js"
- "!vendor/**"
path_instructions:
- path: "src/api/**"
instructions: |
Review for: input validation, proper HTTP status codes, auth middleware usage,
error response format per RFC 7807. Flag missing error handling.
- path: "src/db/**"
instructions: |
Review for: parameterized queries (no string concatenation), transaction boundaries,
proper connection cleanup, index usage. Flag N+1 query patterns.
- path: "**/*.test.*"
instructions: |
Review for: assertion completeness, edge case coverage, proper async handling.
Do NOT comment on test naming conventions or import order.
- path: ".github/workflows/**"
instructions: |
Review for: pinned action versions (use SHA not tag), no secrets in logs,
timeout-minutes on all jobs, OIDC for cloud auth.
chat:
auto_reply: true
# Finishing touches configuration
reviews:
finishing_touches:
docstrings:
enabled: true # Allow @coderabbitai generate-docstrings command
