Skip to main content

What is the PR summary

CodeRabbit appends a generated summary to the bottom of the PR description after a review. The summary groups changes by type — new features, bug fixes, documentation updates, and so on — so reviewers can quickly understand the scope of a PR before diving into individual files.
CodeRabbit Summary

A generated PR summary appended to the pull request description, grouping changes by type

The summary is regenerated on every incremental push, so it always reflects the latest state of the branch.

Controlling placement

By default the summary is appended to the bottom of the description. You can pin it to a specific location by adding the summary placeholder anywhere in the description:
GitHub PR description editor showing the @coderabbitai summary placeholder wrapped in separator lines

A PR description containing the @coderabbitai summary placeholder, which CodeRabbit replaces with the generated summary after review

When the review runs, CodeRabbit replaces that placeholder with the generated summary. The placeholder text itself is configurable via high_level_summary_placeholder and defaults to @coderabbitai summary. The placeholder still produces a summary when high_level_summary is false, as long as high_level_summary_in_walkthrough is also false.

Customizing the summary

The recommended way to configure summary settings is via the .coderabbit.yaml file. You can also adjust them through the CodeRabbit web interface at Configuration → Reviews → Summary.
high_level_summary_instructions accepts free-form text that tells CodeRabbit what to include and how to structure the summary. CodeRabbit follows these instructions on every review.

Moving the summary to the walkthrough

To keep your PR description clean and consolidate all CodeRabbit output in one place, set high_level_summary_in_walkthrough to true. The summary will appear at the top of the walkthrough comment instead of the description.
.coderabbit.yaml

Disabling the summary

Set high_level_summary to false to stop CodeRabbit from writing a summary.
.coderabbit.yaml
When high_level_summary is false and high_level_summary_in_walkthrough is also false, CodeRabbit still generates the summary and inserts it where the @coderabbitai summary placeholder is in the description. Without the placeholder, it writes no summary.
For the full list of summary options with types and defaults, see the configuration reference.

Generating the pull request title

To have CodeRabbit write the pull request title, put the title placeholder anywhere in the title:
@coderabbit works too. CodeRabbit replaces only the placeholder and keeps the rest of the title. It writes the title when it reviews the pull request, so a placeholder added after the last review takes effect at the next one. The placeholder text is configurable via auto_title_placeholder and defaults to @coderabbitai. To change how CodeRabbit writes titles, describe what you want in reviews.auto_title_instructions.

What’s next

Triage

Prioritize your PR queue by value and risk, using each pull request’s summary to judge scope at a glance.

PR Walkthroughs

Read the review sections CodeRabbit posts alongside inline comments and the summary.

Change Stack

Inspect the pull request in logical cohorts and layers after choosing it in Triage.