Skip to content

info/report-titles #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 8, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add preview note
  • Loading branch information
alexcoderabbitai committed Jan 8, 2025
commit f21207af21f5676a2f978feca65961dfe41cfa02
2 changes: 2 additions & 0 deletions docs/guides/custom-reports.md
Original file line number Diff line number Diff line change
@@ -137,6 +137,8 @@ CodeRabbit supports markdown formatting in custom reports. You can use:

The name you give to each report in the CodeRabbit menu will be used for the first line of any report or the subject for emails. For example if your report is named `Executive Summary Template` then this string will appear on the subject of your emails and start of all message chains.

When using the `Preview Report` button in the CodeRabbit menu, the subject will begin with `Preview: <report name>`.

The reports will also have an overall title describing the report content such as `Pull Request Summary Report (January 2025)`.

To change these details of this overall title you should include specific instructions in your custom prompt with examples such as: