How to Use CodeRabbit

Getting started with CodeRabbit

In this guide, you'll learn how to set up CodeRabbit for automated code reviews, enabling you to improve your code quality with actionable feedback and security analysis. You’ll be ready to integrate it with your version control system and conduct your first review in minutes.

Step 1: Sign up and set up

1. Go to CodeRabbit's website.
2. Click on the “Get Started for Free” button in the top right corner.
3. Choose the free tier for open-source projects or select a Pro plan if needed.
4. Complete the sign-up form with your email and password, then confirm your account via the email link sent to you.
5. Once logged in, connect your GitHub or GitLab account by clicking on the “Integrate” button and following the prompts to authorise access.

Step 2: Your first code review

1. Navigate to your repository in GitHub or GitLab where you want to conduct a review.
2. Create a pull request (PR) for the code changes you want reviewed.
3. In the PR description, mention CodeRabbit by typing “@CodeRabbit” to trigger the review process.
4. After a few moments, check back on the PR page; you should see a new comment from CodeRabbit with feedback and suggestions on your code.

Step 3: Get better results

1. To improve the quality of feedback, ensure your code is well-commented. CodeRabbit uses context from comments to provide better insights.
2. Use specific keywords in your PR description (e.g., “security check” or “performance review”) to guide CodeRabbit on what to focus on.
3. Regularly check the “Settings” tab in your CodeRabbit dashboard to adjust the review parameters, like enabling or disabling specific checks for security or style guidelines.

Pro tip

Use the “Batch Review” feature for multiple PRs. Instead of reviewing them one at a time, you can select several and have CodeRabbit analyse them all at once, saving you time.

Common mistake to avoid

Avoid neglecting to give CodeRabbit enough context in your pull request. If your code changes are complex, include detailed comments and explanations in the PR description to ensure you receive the most relevant feedback.