Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit40ab6f8

Browse files
adding result and prompt examples for report
1 parent4b8f966 commit40ab6f8

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

‎docs/guides/custom-reports.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,67 @@ Then CodeRabbit will reply with a score for you pull request:
384384

385385
</details>
386386

387+
You can then utilize this in a report. We recommend your report looks specifically for these score cards and puts together a unified report:
388+
389+
<details>
390+
<summary>Click to view example Report Prompt when using Score Card/Chart:</summary>
391+
392+
![Report Example](/img/guides/score-card-report-result.png)
393+
394+
Prompt Example:
395+
396+
```markdown
397+
Use the <overall_instructions> to guide the content of the summary. Use the format shown in <example> but do not include or refer to the example's content in the final summary/report.
398+
399+
<overall_instructions>
400+
**Instructions:**
401+
402+
Locate the score chart comment in the <bot_comments>. There will be a single comment with data on these fields:
403+
404+
- **User Name (User)**
405+
- **Basic Code Standards (BCS) (out of 2)**
406+
- **Code Readability (CR) (out of 2)**
407+
- **Error Handling (EH) (out of 4)**
408+
- **Shopify Theme Check (CI) (out of 1)**
409+
- **Final Code Quality Score (FCQS) (out of 9)**
410+
411+
These details may also be in the form of a chart such as:
412+
413+
## Score Chart
414+
415+
| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) |
416+
| -------- | ------- | ------ | ------ | ------ | -------- |
417+
| John Doe | 2 | 3 | 2 | 1 | 9 |
418+
419+
You will create a new chart averaging all the values from various pull requests for each author. Only include pull requests with a `Score Chart`. Do not invent or create score charts if none exist.
420+
421+
</overall_instructions>
422+
423+
<example>
424+
425+
## Column Notation
426+
427+
- **User Name (User)**
428+
- **Basic Code Standards (BCS) (out of 2)**
429+
- **Code Readability (CR) (out of 2)**
430+
- **Error Handling (EH) (out of 4)**
431+
- **Shopify Theme Check (CI) (out of 1)**
432+
- **Final Code Quality Score (FCQS) (out of 9)**
433+
434+
## Score Chart
435+
436+
| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) | PR URL |
437+
| -------- | ------- | ------ | ------ | ------ | -------- | ------ |
438+
| John Doe | 2 | 3 | 2 | 1 | 9 | URL |
439+
| Alex Foo | 2 | 3 | 2 | 1 | 9 | URL |
440+
441+
</example>
442+
<include_bot_comments>
443+
<pr_score_card>
444+
```
445+
446+
</details>
447+
387448
**Best Practices for Score Cards/Charts:**
388449

389450
- The reporting bot only has access to your comments and summary (like a project manager) if you want to make a report looking for these score card/chart comments make sure the reviewer does this ahead of time.
69.9 KB
Loading

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp