From 09e33bfc5ed2555a0d781f9b01c4a27bbd8f3cd0 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 8 Jan 2025 15:25:24 -0500 Subject: [PATCH 1/6] update note on custom reports --- docs/guides/scheduled-reports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md index f65e8991..02507528 100644 --- a/docs/guides/scheduled-reports.md +++ b/docs/guides/scheduled-reports.md @@ -97,7 +97,7 @@ CodeRabbit offers several built-in templates: 1. **Daily Standup Report**: A concise summary of pull requests and activities. 2. **Sprint Report**: A structured overview of sprint goals, completed tasks, in-progress work, and blockers. 3. **Release Notes**: A high-level changelog with summary and significant changes. -4. **[Custom Templates](./custom-reports.md)**: Create your own format using prompts. Has support for multiple languages. +4. **[Custom Templates](custom-reports.md)**: Create your own format using prompts. Allows for endless customization such as native language reporting (Japanese, Spanish, French, etc.), custom formatting, custom titles, and more. Example custom prompt: From e78c2971e6ce0ed9c3135dddf8c8848b70456488 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 8 Jan 2025 15:35:01 -0500 Subject: [PATCH 2/6] add note on changing overall title --- docs/guides/custom-reports.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 1325c12c..7068ab4e 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -133,6 +133,18 @@ CodeRabbit supports markdown formatting in custom reports. You can use: - Bold and italic text - Links +### Headers and Titles + +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. + +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: + +``` +- Do not add a date to the titles like "Pull Request Summary Report (January 2025)" it should just be "Pull Request Summary Report" +``` + ### Language Support You can generate reports in multiple languages by specifying the ISO language code in your template. For example: From 0a040efe0f50a7c0323a96cf03a33d9b1e43c128 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 8 Jan 2025 15:46:04 -0500 Subject: [PATCH 3/6] fix text --- docs/guides/custom-reports.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 7068ab4e..54c0134e 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -141,7 +141,7 @@ The reports will also have an overall title describing the report content such a To change these details of this overall title you should include specific instructions in your custom prompt with examples such as: -``` +```text - Do not add a date to the titles like "Pull Request Summary Report (January 2025)" it should just be "Pull Request Summary Report" ``` From 957eb20d47786e274a60974465777cb6003822b6 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 8 Jan 2025 15:49:14 -0500 Subject: [PATCH 4/6] add note on examples --- docs/guides/custom-reports.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index 54c0134e..b5732537 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -226,6 +226,13 @@ Provide: - Include visual breaks - Maintain consistent styling +5. **Use Examples** + - Include "do this" and "don't do this" examples (especially for titles) + - Demonstrate proper formatting patterns + - Show concrete use cases for different report types + - Help maintain consistency across teams + - Avoid ambiguity in report generation + ## Example Templates ### Executive Summary Template From 8ab640f6c6f1bba5ad63aab3cc380a05638592d1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 8 Jan 2025 20:49:40 +0000 Subject: [PATCH 5/6] =?UTF-8?q?=F0=9F=8E=A8=20pnpm=20run=20lint:fix?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [dependabot skip] --- docs/guides/custom-reports.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index b5732537..5838fd77 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -222,6 +222,7 @@ Provide: - Consider your audience's needs 4. **Optimize Readability** + - Use appropriate formatting - Include visual breaks - Maintain consistent styling From f21207af21f5676a2f978feca65961dfe41cfa02 Mon Sep 17 00:00:00 2001 From: alex Date: Wed, 8 Jan 2025 15:56:40 -0500 Subject: [PATCH 6/6] add preview note --- docs/guides/custom-reports.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md index b5732537..4762daf0 100644 --- a/docs/guides/custom-reports.md +++ b/docs/guides/custom-reports.md @@ -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: `. + 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: