Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 2.57 KB

coderabbit.rst

File metadata and controls

66 lines (49 loc) · 2.57 KB

CodeRabbit

This page explains how to configure and use CodeRabbit for CCCL pull request review. For the complete product documentation, see the CodeRabbit documentation.

Configuration

CCCL configures CodeRabbit through .coderabbit.yaml in the repository root. The configuration in the pull request branch is used for that review.

When setting up or updating CodeRabbit:

  1. Keep repository-specific settings in .coderabbit.yaml.
  2. Use @coderabbitai configuration on a pull request to inspect the resolved configuration. This is useful when checking whether CodeRabbit is using the expected repository settings for that pull request.
  3. Use @coderabbitai generate configuration to export the resolved configuration if a new baseline is needed. This is useful when moving settings into a reviewable repository configuration file.
  4. Keep configuration changes small and reviewable.
  5. Use reviews.path_instructions for path-specific review guidance.
  6. Use knowledge_base.code_guidelines.filePatterns for CCCL guidance files that CodeRabbit should read as review context.

The CCCL configuration should keep comments focused on correctness, API stability, performance, security, and other high-impact issues. Avoid enabling features that add noisy generated comments or code by default.

Pull Request Reviews

Automatic reviews may be disabled or restricted by the repository configuration. Maintainers can always request review explicitly from a pull request comment:

@coderabbitai review

Use a full review when the pull request should be reviewed again from scratch:

@coderabbitai full review

Other useful commands:

  • @coderabbitai help shows the current command reference.
  • @coderabbitai configuration shows the active configuration.
  • @coderabbitai summary can be placed in the pull request description as a placeholder for the generated summary.
  • @coderabbitai pause and @coderabbitai resume pause or resume automatic review behavior. This is useful when a pull request is still being updated frequently and should not be reviewed again until it is ready.
  • @coderabbitai ignore can be placed in the pull request description to disable automatic reviews.

Review Guidance

Treat CodeRabbit feedback as review assistance, not as a merge requirement by itself. Maintainers remain responsible for deciding whether comments are actionable and whether a pull request has adequate tests and CI coverage.