diff --git a/docs/develoepr-guide/ai-reviewer-output-format.md b/docs/develoepr-guide/ai-reviewer-output-format.md new file mode 100644 index 0000000..d39cc43 --- /dev/null +++ b/docs/develoepr-guide/ai-reviewer-output-format.md @@ -0,0 +1,101 @@ +# AI Code Reviewer — Output Comment Format + +## 1. Summary Comment + +The summary comment is posted by the bot as a **top-level PR comment** after the review is complete. +It provides a high-level assessment of the entire diff. + +### Format + +``` +🔴 Code quality assessment: + +â„šī¸ Conclusion: + +❌ Merge: No - +✅ Merge: Yes +``` + +### Example + +> 🔴 Code quality assessment: Poor +> +> â„šī¸ Conclusion: The commit introduces a critical bug where `Stopwatch.StartNew()` is called twice on consecutive lines (lines 15–16 in `samples/AR/App.cs`). The duplicate assignment statement must be removed. +> +> ❌ Merge: No - blocking issue must be resolved first + +### Quality Levels + +| Badge | Label | Meaning | +|---|---|---| +| 🔴 | Poor | Blocking issues found, must not merge | +| 🟡 | Acceptable | Minor suggestions only | +| ✅ | Excellent | No issues found | + +--- + +## 2. Inline Comments + +Inline comments are posted **directly on the changed lines** in the diff. +They follow the [**Conventional Comments**](https://conventionalcomments.org/) approach to make severity and intent immediately clear. + +### Conventional Comments Format + +``` +