diff --git a/2.-How-Kodo-Works.md b/2.-How-Kodo-Works.md deleted file mode 100644 index 4583467..0000000 --- a/2.-How-Kodo-Works.md +++ /dev/null @@ -1,40 +0,0 @@ -# Gitea VCS Usage - -# Introduction - -When working with Gitea, you can use several methods to interact with the tool. - -# 1. Launch of code review - -To start a code review, you must first prepare the following: - -1. Push the branch with changes to the remote repository -2. Create a Pull Request in Gitea VCS, adding the `@kodobot` reviewer user to the Pull Request - -## 1.1. Automatic Start - -After completing the preparatory stage of creating a Pull Request with the AI reviewer added, the code review **will be launched automatically.** - -## 1.2. Manual Start - -If for some reason you need to start the review yourself, use the `@kodobot` tag when writing a comment in the pull request. - -# 2. Code review prevention - -To prevent the review from starting, we can use the following methods - -## 2.1. Tag [no ai] in the pull request title - -When a pull request is created with the tag `[no ai]` in the pull request title, and when new changes are pushed to the pull request, the reviewer will not be triggered for that pull request. -This can be useful if you use `CODEOWNERS` file in your repository. - -## 2.2. Do not add AI use to PR - -You can choose not to add the `@kodobot` AI Reviewer user at all, and then the kodo review tool will never run for this Pull Request. - -⚠️ **Important:** you **do not need** to write the `[no ai]` tag if no AI user has been added to the Pull Request for review. - -# 3. Questions for AI - -You can use the `@kodobot` tag in a Pull Request comment to ask the AI anything. After adding the `@kodobot` tag to your message you will receive a response from AI user. - diff --git a/7.-Troubleshooting.md b/7.-Troubleshooting.md deleted file mode 100644 index b8cc378..0000000 --- a/7.-Troubleshooting.md +++ /dev/null @@ -1,46 +0,0 @@ -# Troubleshooting: Reviewer Did Not Run - -## Quick Checklist - -Before diving deeper, verify the basics: - -- The workflow file exists at `.gitea/workflows/kodo-reviewer.yaml` -- Secrets `CC_GITEATOKEN` and `CC_API_KEY` are set in repository settings -- The runner `kodo-review` is online and available -- The PR title does **not** contain `[no ai]` -- The event that triggered the workflow matches one of the configured triggers - ---- - -## Common Causes & Fixes - -### 1. Secrets are missing or misconfigured - -If `CC_GITEATOKEN` or `CC_API_KEY` are not set, the action will fail silently or error out. - -**How to check:** -1. Go to repository **Settings → Secrets** -2. Verify both secrets exist: - - `CC_GITEATOKEN` — Gitea token with read/write access to PRs - - `CC_API_KEY` — Anthropic API key - -**Fix:** Add/regenerate missing secrets or contact with `devops` team. - ---- - -### 2. PR title contains `[no ai]` - -The action checks for `[no ai]` in the PR title and skips execution if found. - -**Fix:** Remove `[no ai]` from the PR title and push a new commit or re-open the PR. - ---- - -## Still Not Working? - -Provide the following information when asking for help from `devops` team: - -- Runner name and status (`kodo-review`) -- Workflow run URL -- Event that was expected to trigger the review -- Observed and expected behavior diff --git a/5.-Output-Comment-Format.md b/developer-guide/ai-reviewer-output-format.md similarity index 96% rename from 5.-Output-Comment-Format.md rename to developer-guide/ai-reviewer-output-format.md index bc09b12..d39cc43 100644 --- a/5.-Output-Comment-Format.md +++ b/developer-guide/ai-reviewer-output-format.md @@ -1,101 +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 - -``` -