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
@@ -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 askedcoderabbit to create a "Score Card"thourhg a comment or implemented 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 askedCodeRabbit to create a "Score Card"through a comment or implemented the "Score Chart" bot comment flow below.
311
311
312
-
For example you can askcoderabbit to check several conditions on a pull request and produce a "Score Chart":
312
+
For example, you can askCodeRabbit 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>
@@ -461,7 +461,7 @@ You will create a new chart averaging all the values from various pull requests
461
461
- Only include checks for very specific scenarios, such as a specific check failing or using tabs vs spaces.
462
462
- Do not use general rules without explaining specifically what they mean. If you add "Insure the pull request follows development best practices" you must define what "development best practices" actually mean or the AI will guess.
463
463
- Make one point for each specific check and make sure its a True/False condition.
464
-
- Instead of manually commenting on pull requests you can use the[Github Actions Bot](https://github.com/marketplace/actions/create-or-update-comment) to automatically comment on pull requests and triggercoderabbit score card/chart comments by including`@coderabbit` in the comment.
464
+
- Instead of manually commenting on pull requests, you can use the[GitHub Actions Bot](https://github.com/marketplace/actions/create-or-update-comment) to automatically comment on pull requests and triggerCodeRabbit score card/chart comments by including`@coderabbitai` in the comment.