Skip to content

Commit 373f1c2

Browse files
Merge branch 'coderabbitai:main' into main
2 parents b4dc69e + 9cd059e commit 373f1c2

23 files changed

+629
-68
lines changed

docs/changelog.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,42 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

8+
## May 25, 2025
9+
10+
### New Security and Code Quality Tools
11+
12+
We're excited to announce the addition of two powerful tools to our static analysis arsenal:
13+
14+
- **Brakeman**: A static analysis security vulnerability scanner for Ruby on Rails applications. It helps identify security issues in your Ruby codebase by analyzing Gemfile, Ruby files (_.rb), and ERB templates (_.erb).
15+
16+
- **Clippy**: The official linter for Rust code, helping catch common mistakes and improve your Rust code quality. It analyzes \*.rs files and supports configuration through clippy.toml files.
17+
18+
Both tools can be configured through their respective config files or through CodeRabbit's settings page. See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
19+
820
## May 19, 2025
921

1022
### Lua Support with Luacheck
1123

1224
We're excited to announce enhanced support for Lua code analysis with [Luacheck](https://github.com/mpeterv/luacheck), a powerful static analyzer and linter for Lua code.
1325

26+
## May 14, 2025
27+
28+
### CodeRabbit for VS Code, Cursor, and Windsurf Is Here 🎉
29+
30+
We're thrilled to announce that CodeRabbit's AI code reviews have officially landed inside **VS Code and all its forks, including Cursor and Windsurf!** No more review bottlenecks or context switches: now you can get _instant, inline feedback right in your editor, completely free._
31+
32+
**Why you'll love it:**
33+
34+
- 📝 **Inline Code Reviews**: Senior-dev-level annotation on every line. CodeRabbit becomes your AI pair programmer, annotating staged & unstaged commits before you even open a PR.
35+
- 🚀 **Built for Flow, Not Friction**: Code, review, commit—rise & repeat without breaking your flow state. Reviews run automatically on every commit so you ship faster.
36+
- 🛠️ **Fix-with-AI**: One-Click Fix for quick tweaks; "Fix with AI" hands off more complex suggestions to your favorite coding agent, complete with full context.
37+
- 🧩 **Compatible with Cursor, Windsurf & Language-Agnostic**: Works out of the box on VS Code, Cursor, Windsurf. Supports Java, JavaScript, PHP, Python, TypeScript, Go, Ruby, and more.
38+
39+
Pair these IDE-embedded reviews with our deeper Git-platform reviews for a multi-layered approach that catches more bugs and cuts down overall review time.
40+
41+
- [Join the launch discussion on Discord](https://discord.com/channels/1134356397673414807/1145813948193575023/1372210767838842950)
42+
- [Install the CodeRabbit VSCode Extension](https://coderabbit.link/vscode)
43+
1444
## April 19, 2025
1545

1646
### Docstring Path Instructions

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The following limits enforced _per developer_:
128128
| ---------------- | ------------------------------------------ | ----------------------------- | ----------------------------- | ----------------------------- |
129129
| Files per hour | 200/hour | 200/hour | 200/hour | 400/hour |
130130
| Files per PR | 100 | 100 | 100 | 200 |
131-
| Reviews per hour | 3 back-to-back, then 3/hour (Summary only) | 4 back-to-back, then 4/hour | 3 back-to-back, then 3/hour | 5 back-to-back, then 5/hour |
131+
| Reviews per hour | 3 back-to-back, then 2/hour (Summary only) | 4 back-to-back, then 3/hour | 3 back-to-back, then 2/hour | 5 back-to-back, then 4/hour |
132132
| Chat | N/A | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour |
133133

134134
## Integration Guide {#integration-guide}
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Code review best practices
3+
description: Best practices for managing CodeRabbit code reviews.
4+
sidebar_label: Best practices
5+
---
6+
7+
This page lists best practices for performing code reviews with CodeRabbit.
8+
9+
For more information about working with
10+
CodeRabbit through chat, see [Control and manage code reviews](/guides/commands).
11+
12+
For a CodeRabbit command reference, see [Code review command reference](/reference/review-commands).
13+
14+
## Recommended code-review workflow
15+
16+
- Start with `@coderabbitai review` for checking new changes.
17+
- Use `@coderabbitai full review` when major changes require a fresh perspective.
18+
- Generate summaries after significant updates using `@coderabbitai summary`.
19+
20+
## Managing large changes
21+
22+
- Use `@coderabbitai pause` before making multiple commits.
23+
- Resume reviews with `@coderabbitai resume` when ready.
24+
- Consider `@coderabbitai full review` after substantial changes.
25+
26+
## Documentation flow
27+
28+
- Run `@coderabbitai generate docstrings` after finalizing function implementations.
29+
- Learn more about [docstring generation](/finishing-touches/docstrings).
30+
31+
## Overall tips
32+
33+
- Commands are case-insensitive (`@coderabbitai REVIEW` works the same as `@coderabbitai review`).
34+
- Commands can be issued by anyone with write access to the repository.
35+
- Multiple commands can be used in sequence as needed.
36+
- Use `@coderabbitai configuration` to export your settings before making changes.
37+
38+
## Command response time
39+
40+
- Most commands (pause, resume, ignore) take effect immediately.
41+
- Review commands typically complete within a few minutes, depending on PR size.
42+
- Docstring generation time varies based on the number of functions.

docs/guides/code-review-overview.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: Review pull requests
3+
description: An overview of CodeRabbit's core code review features.
4+
sidebar_label: Overview
5+
---
6+
7+
The central feature of CodeRabbit is its ability to proactively review
8+
new pull requests on your code repository.
9+
10+
CodeRabbit reviews take the form of pull request comments that
11+
include summaries, analyses, and initial critiques of the proposed changes.
12+
This information, usually added to pull requests within minutes, can help your team perform more rapid, better-informed code reviews.
13+
14+
The following sections present an overview of this feature. For a hands-on example that lets you experience a CodeRabbit code review using
15+
a real repository, see [Quickstart](/getting-started/quickstart).
16+
17+
## Automatically review pull requests {#review}
18+
19+
After you [integrate CodeRabbit with your repository](/platforms), CodeRabbit proceeds
20+
to automatically review every subsequent pull request, as soon as each one is created.
21+
22+
CodeRabbit performs code reviews by attaching comments to the pull request.
23+
These comments contain detailed summaries and analyses of the changes,
24+
as well as listing out problems or areas for potential improvement that it found.
25+
26+
CodeRabbit uses [a variety of open-source linters and security tools](/tools) and a custom
27+
code verification agent to provide this analysis. CodeRabbit
28+
also consults several models to further analyze and critique the proposed changes,
29+
using all of the content of your repository as context. The code-review comment that CodeRabbit attaches
30+
to your pull request synthesizes and summarizes all of the information collected from these different sources.
31+
32+
For more information about the graph analysis that CodeRabbit includes with its reviews
33+
when available, see [CodeRabbit Code Graph Analysis](/integrations/code-graph-analysis).
34+
35+
### Events that trigger automated reviews {#events}
36+
37+
By default, the following activity in your repository triggers CodeRabbit to
38+
perform a code review:
39+
40+
- If CodeRabbit sees a new pull request, then it immediately performs a full review
41+
of the proposed code changes.
42+
- If an open pull request that CodeRabbit has already reviewed gets modified with another
43+
commit, then CodeRabbit performs an incremental review that focuses on the new commit.
44+
45+
## Interact with CodeRabbit reviews {#interact}
46+
47+
After CodeRabbit attaches its initial code-review comment to a pull request, you can
48+
directly interact with CodeRabbit by mentioning its username, `@coderabbitai`, in comments
49+
that you post to the pull request.
50+
51+
These interactions can serve several purposes:
52+
53+
- Free-form discussion about the pull request and the ongoing code review.
54+
- Commands to have CodeRabbit perform specific actions regarding the code review.
55+
- Prompts to have CodeRabbit generate its own improvements to the branch under review.
56+
57+
### Chat with CodeRabbit {#chat}
58+
59+
You can have open-ended, natural-language discussion with CodeRabbit during a code review, treating it
60+
as an LLM-powered chatbot that has your entire code repository available for context. For more information, see [CodeRabbit Chat](/guides/agent_chat).
61+
62+
### Manage CodeRabbit review behavior {#manage}
63+
64+
CodeRabbit recognizes a variety of keyword-based commands that let you control its
65+
behavior during a code review, including the following:
66+
67+
- Pause or resume automated reviews of the pull request.
68+
- Manually request a review, when automated reviews are paused.
69+
- Resolve all open comments authored by CodeRabbit.
70+
71+
For more information, see [Control and manage code reviews](/guides/commands).
72+
73+
### Generate improvements {#generate}
74+
75+
You can command CodeRabbit to generate improvements to the branch under review.
76+
CodeRabbit accomplishes this by publishing a new branch based on the branch under review,
77+
and creating a new pull request for your own review.
78+
79+
Available code-generation commands let you request the following from CodeRabbit:
80+
81+
- Implement the suggestions for improvements that CodeRabbit has made in its earlier code review comments.
82+
- Generate inline documentation for any undocumented functions that this pull request proposes to add.
83+
84+
For more information, see [Generate improvements](/guides/generate-improvements).
85+
86+
## What's next {#whats-next}
87+
88+
- [Control and manage code reviews](/guides/commands)
89+
- [Generate code improvements](/guides/generate-improvements)
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Code review troubleshooting
3+
description: Troubleshooting CodeRabbit code reviews.
4+
sidebar_label: Troubleshooting
5+
---
6+
7+
This page is about troubleshooting interactive code review sessions with CodeRabbit. For more information about working with
8+
CodeRabbit through chat, see [Control and manage code reviews](/guides/commands).
9+
10+
If a CodeRabbit command doesn't seem to work:
11+
12+
1. Check that you have the necessary repository permissions.
13+
2. Verify the command syntax.
14+
3. Look for any response from CodeRabbit in the PR comments.
15+
4. Use `@coderabbitai help` for command guidance.
16+
17+
Need help? Join our community on [Discord](https://discord.gg/coderabbit) or [contact our support team](/getting-started/support).

0 commit comments

Comments
 (0)