You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the introduction document to highlight CodeRabbit as an AI-first code reviewer, emphasizing its unique features such as context-aware feedback, integration with GitHub and GitLab, and a strong focus on data privacy and security. Also, added new sections on the working mechanism, data privacy, security, and a comparative analysis with other code review tools.
The recent updates to CodeRabbit's documentation highlight its evolution into a more sophisticated AI-driven code review tool. These revisions underscore its ability to deliver context-aware feedback, seamless integration with popular version control platforms like GitHub and GitLab, and a strong commitment to data privacy and security. The introduction now offers insights into its functionality, privacy measures, and advantages over traditional code review tools.
Changes
File Path
Summary of Changes
docs/introduction/introduction.md
Updated to emphasize CodeRabbit as an AI-driven code reviewer, detailing its context-aware feedback, integration capabilities, and focus on data privacy and security. Added sections on functionality, privacy/security, and a comparison with other tools.
🐰✨
In the land of code and byte,
A rabbit hops into the night.
Reviewing code with AI might,
Ensuring all your codes take flight.
🚀🌌
Tips
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>.
Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
@coderabbitai generate unit tests for this file.
@coderabbitai modularize this function.
PR comments: Tag @coderabbitai 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:
@coderabbitai generate interesting stats about this repository from git and render them as a table.
@coderabbitai show all the console.log statements in this repository.
@coderabbitai read src/utils.ts and generate unit tests.
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
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 as PR comments)
@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration File (.coderabbit.yaml)
You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
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/coderabbit-overrides.v2.json
CodeRabbit Discord Community
Join our Discord Community to get help, request features, and share feedback.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![coderabbitaidev[bot]](https://avatars.githubusercontent.com/in/375467?s=60&v=4){kind=small}
Summary by CodeRabbit