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.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitaidev in a new review comment at the desired location with your query. Examples:
  • @coderabbitaidev generate unit testing code for this file.
  • @coderabbitaidev modularize this function.
• PR comments: Tag @coderabbitaidev 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:
  • @coderabbitaidev gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitaidev read src/utils.ts and generate unit testing code.
  • @coderabbitaidev read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitaidev help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitaidev pause to pause the reviews on a PR.
• @coderabbitaidev resume to resume the paused reviews.
• @coderabbitaidev review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitaidev full review to do a full review from scratch and review all the files again.
• @coderabbitaidev summary to regenerate the summary of the PR.
• @coderabbitaidev generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitaidev resolve resolve all the CodeRabbit review comments.
• @coderabbitaidev configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitaidev help to get help.

Other keywords and placeholders

• Add @coderabbitaidev ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitaidev summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitaidev or @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

Documentation and Community

• 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.