You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/guides/custom-reports.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,7 +103,7 @@ Contained within the `<pr_details>` tag.
103
103
#### Summarized PR Details
104
104
105
105
-`<pr_description>`: string - Contains the body of your pull request (aka the PR description at the top of the PR page).
106
-
-`<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI durring the PR review process. This includes several sections for each file that was changed:
106
+
-`<file_changes_summary>`: string - Contains a file by file summary of the changes made in the PR in markdown format. This summary is generated by CodeRabbit AI during the PR review process. This includes several sections for each file that was changed:
107
107
-`filename`: string - The name of the file that was changed.
108
108
-`AI-generated summary of changes`: markdown - An overall summary of the changes made in the file.
109
109
-`Alterations to the declarations of exported or public entities`: markdown - A more specific breakdown of the changes made to the file such as exactly what was added, removed, or modified.
@@ -307,9 +307,9 @@ Issues and tickets brings in conversations, descriptions, and comments from Jira
307
307
308
308
This option gives you the ability to create a report limited only to pull requests containing a "Score Card" or "Score Chart" bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag `<pr_score_card>` in your prompt.
309
309
310
-
> **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked CodeRabbit to create a "Score Card" through a comment or implimented the "Score Chart" bot comment flow below.
310
+
> **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have asked CodeRabbit to create a "Score Card" through a comment or implemented the "Score Chart" bot comment flow below.
311
311
312
-
For example you can ask CodeRabbit to check serveral conditions on a pull request and produce a "Score Chart":
312
+
For example you can ask CodeRabbit to check several conditions on a pull request and produce a "Score Chart":
313
313
314
314
<details>
315
315
<summary>Click to view example User Score Card/Chart Comment:</summary>
Copy file name to clipboardExpand all lines: docs/guides/ondemand-reports.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
14
14
15
15
This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
16
16
17
-
If you're new to CodeRabbit's reporting features, then we recommend starting with [Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benifits from the **Scheduled Reports** and has many limitations.
17
+
If you're new to CodeRabbit's reporting features, then we recommend starting with [Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities. In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benefits from the **Scheduled Reports** and has many limitations.
Copy file name to clipboardExpand all lines: docs/guides/reports-overview.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ There are two ways to generate reports:
26
26
27
27
-**[On-demand Reports](/guides/ondemand-reports)**: If you want to test a report format and produce a single report once, try the "On-demand Reports" Option. You can also generate reports programmatically through our API, but we do not recommend this as the API reporting is in beta. If you want to run an **On-demand Report** more than once then you must use the **Scheduled Reports** option.
28
28
29
-
In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benifits from the **Scheduled Reports** and has many limitations.
29
+
In almost every scenario we recommend using the **Scheduled Reports** option. The **On-demand Report** does not have any additional benefits from the **Scheduled Reports** and has many limitations.
30
30
31
31
## Customize reports using natural language {#customize}
Copy file name to clipboardExpand all lines: docs/reference/configuration.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -604,8 +604,8 @@ Set the commit status to 'pending' when the review is in progress and 'success'
604
604
Activate this setting to disallow CodeRabbit from caching your repository's code and dependencies. This forces CodeRabbit to download the code and dependencies fresh from the repository for every code review that it performs.
605
605
606
606
When caching is allowed, then CodeRabbit stores a cache of code and metadata from
607
-
your repostory for up to seven days after its most recent code review. This cache
608
-
lets CodeRabbit save time and effort in between subsquent reviews of the same
607
+
your repository for up to seven days after its most recent code review. This cache
608
+
lets CodeRabbit save time and effort in between subsequent reviews of the same
609
609
repository. For more information, see [Caching](/reference/caching/).
610
610
611
611
We recommend leaving this setting off, which allows caching, and can speed up
@@ -902,10 +902,10 @@ For more information, see [Speed up reviews by adding path filters](https://docs
902
902
</TabItem>
903
903
</Tabs>
904
904
905
-
Path instructions are additional sets of instructions, expressed in natural lanaguge,
906
-
that you provide to CodeRabbit for reveiwing certain files in your repository.
905
+
Path instructions are additional sets of instructions, expressed in natural language,
906
+
that you provide to CodeRabbit for reviewing certain files in your repository.
907
907
908
-
You associate each set of instuctions with a file path relative to the root
908
+
You associate each set of instructions with a file path relative to the root
909
909
of your repository. Your path specification can use extended glob patterns.
910
910
911
911
The following example defines a set of path instructions for all TypeScript
@@ -929,7 +929,7 @@ path_instructions:
929
929
</TabItem>
930
930
</Tabs>
931
931
932
-
For further examples of path instructions specific to various programming langauges,
932
+
For further examples of path instructions specific to various programming languages,
933
933
see [the `awesome-coderabbit` public repository](https://github.com/coderabbitai/awesome-coderabbit/tree/main/configs).
0 commit comments