Update Home
@@ -1,54 +1,54 @@
|
|||||||
# Kodo AI Reviewer
|
# Kodo AI Reviewer
|
||||||
|
|
||||||
## 🤖 What is it?
|
## 🤖 What is it?
|
||||||
|
|
||||||
Kodo AI Reviewer is an AI-powered automated code review tool. It integrates into your CI/CD pipeline, analyzes pull request changes, and helps teams maintain high code quality — without the bottlenecks of manual review.
|
Kodo AI Reviewer is an AI-powered automated code review tool. It integrates into your CI/CD pipeline, analyzes pull request changes, and helps teams maintain high code quality — without the bottlenecks of manual review.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🚀 Why use it?
|
## 🚀 Why use it?
|
||||||
|
|
||||||
| | Feature | What it means for you |
|
| | Feature | What it means for you |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| ⏱️ | **Saves time** | Automates the routine review process so engineers focus on what matters |
|
| ⏱️ | **Saves time** | Automates the routine review process so engineers focus on what matters |
|
||||||
| 📋 | **Single source of truth** | Consistent, reproducible feedback — no human bias or mood swings |
|
| 📋 | **Single source of truth** | Consistent, reproducible feedback — no human bias or mood swings |
|
||||||
| 📈 | **Better code quality** | Catches style issues, logic flaws, and potential bugs comprehensively |
|
| 📈 | **Better code quality** | Catches style issues, logic flaws, and potential bugs comprehensively |
|
||||||
| 🕐 | **Always available** | Reviews code 24/7 — no waiting for a teammate to free up |
|
| 🕐 | **Always available** | Reviews code 24/7 — no waiting for a teammate to free up |
|
||||||
| 🔧 | **Highly customizable** | Extend built-in rules or create entirely new checks for your needs |
|
| 🔧 | **Highly customizable** | Extend built-in rules or create entirely new checks for your needs |
|
||||||
| 💬 | **Interactive** | Ask follow-up questions and get instant responses to your comments |
|
| 💬 | **Interactive** | Ask follow-up questions and get instant responses to your comments |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🌍 Where does it work?
|
## 🌍 Where does it work?
|
||||||
|
|
||||||
Kodo AI Reviewer works directly inside your **CI/CD pipeline** — it runs automatically on every pull request, no extra setup required beyond the initial configuration.
|
Kodo AI Reviewer works directly inside your **CI/CD pipeline** — it runs automatically on every pull request, no extra setup required beyond the initial configuration.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## ✨ How does it work?
|
## ✨ How does it work?
|
||||||
|
|
||||||
### 🔁 CI/CD Flow
|
### 🔁 CI/CD Flow
|
||||||
|
|
||||||
When a pull request is opened or updated, Kodo kicks in automatically:
|
When a pull request is opened or updated, Kodo kicks in automatically:
|
||||||
|
|
||||||
1. 📥 **Reads the environment** — loads your action configuration and prepares the review context
|
1. 📥 **Reads the environment** — loads your action configuration and prepares the review context
|
||||||
2. 🔍 **Analyzes your changes** — scans the diff for issues, improvements, and code quality signals
|
2. 🔍 **Analyzes your changes** — scans the diff for issues, improvements, and code quality signals
|
||||||
3. 💬 **Leaves comments** — posts inline feedback and a summary conclusion on the PR
|
3. 💬 **Leaves comments** — posts inline feedback and a summary conclusion on the PR
|
||||||
4. 🗣️ *(Optional)* **Responds to you** — mention the predefined tag in any comment and Kodo will reply directly to your question or request
|
4. 🗣️ *(Optional)* **Responds to you** — mention the predefined tag in any comment and Kodo will reply directly to your question or request
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 📚 Documentation
|
## 📚 Documentation
|
||||||
|
|
||||||
### 👩💻 Developer
|
### 👩💻 Developer
|
||||||
- [Code Review with Kodo](how-to-use) — how to trigger, skip, and interact with the reviewer
|
- [Code Review with Kodo](how-to-use) — how to trigger, skip, and interact with the reviewer
|
||||||
- [Review Output Format](ai-reviewer-output-format) — how to read summary comments, inline comments, and PR status
|
- [Review Output Format](ai-reviewer-output-format) — how to read summary comments, inline comments, and PR status
|
||||||
- [Limitations & Best Practices](limitations-and-best-practices) — what Kodo can't do and how to get the most out of it
|
- [Limitations & Best Practices](limitations-and-best-practices) — what Kodo can't do and how to get the most out of it
|
||||||
|
|
||||||
### 🧑🔧 Tech Lead
|
### 🧑🔧 Tech Lead
|
||||||
- [CI/CD Integration](how-to-integrate) — how to add Kodo to your repository workflow
|
- [CI/CD Integration](how-to-integrate) — how to add Kodo to your repository workflow
|
||||||
- [Custom Review Rules](extension-of-rules) — how to extend the built-in rules with project-specific instructions
|
- [Custom Review Rules](extension-of-rules) — how to extend the built-in rules with project-specific instructions
|
||||||
- [Troubleshooting](faq-troubleshooting) — what to check when Kodo doesn't run
|
- [Troubleshooting](faq-troubleshooting) — what to check when Kodo doesn't run
|
||||||
|
|
||||||
### ⚙️ DevOps
|
### ⚙️ DevOps
|
||||||
- [Gitea Token Setup](reviewer-token) — how to generate the bot token and configure repository secrets
|
- [Gitea Token Setup](reviewer-token) — how to generate the bot token and configure repository secrets
|
||||||
Reference in New Issue
Block a user