This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our pricing page for more information about our plans and features.
Overview
This feature is available only on GitHub.
@coderabbitai.
Example requests
plan keyword acts as shorthand for implementing suggested changes.
How it works
1
Analysis & planning
CodeRabbit posts comments to the pull request detailing its improvement plans.
2
Branch creation
CodeRabbit creates a new branch based on the current pull request’s branch.
3
Pull request generation
CodeRabbit opens a new pull request with the improvements and links to it from the original.
CodeRabbit creates the branch and pull request but doesn’t make further changes afterward. You take full ownership of the suggested improvements.
Best practices
Review and customize
Review and customize
Take ownership of the new branch and decide whether to merge the suggestions into your original pull request. Make any additional updates as needed.
Ask for clarification
Ask for clarification
Use comments in the new branch to ask CodeRabbit to explain its changes or discuss the suggested improvements.
Workflow flexibility
Workflow flexibility
The suggested-change branch doesn’t block your original code review. You can merge, defer, or close the suggestion at any time that fits your workflow.
Quick Commands
Common commands for code generation tasks. For complex requests, use full prompts as described above. For a complete command reference, see Code review command reference.Generate Documentation
Generate missing documentation for functions added in the pull request:Learn more about docstrings
Discover supported platforms and programming languages for inline documentation generation.