From 61ca06bfa5253e9e7c4373e124e848e63a835e38 Mon Sep 17 00:00:00 2001 From: Alexey Efimchik Date: Thu, 12 Mar 2026 06:21:18 +0000 Subject: [PATCH] Add Output Comment Format --- Output-Comment-Format.md | 101 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 Output-Comment-Format.md diff --git a/Output-Comment-Format.md b/Output-Comment-Format.md new file mode 100644 index 0000000..bc09b12 --- /dev/null +++ b/Output-Comment-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 + +``` +