From 1a45c53aa23bfe27ab3a19a5ad7a0172a47025f6 Mon Sep 17 00:00:00 2001
From: Jeffery <jiantw83@yahoo.com>
Date: Mon, 11 May 2026 06:22:59 +0000
Subject: [PATCH] Add README.md for AI Code Review Action documentation

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a354bcd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# 簡介
+
+這是一個 AI Code Review Action。Gitea Workflow 可以使用此 Action 讓 AI 助理根據不同面向分析 Push Request 中變更的內容後，將問題分級 Commnet 到 Push Request 中。
+
+# 流程
+
+1. 服務名稱、模型名稱、角色資訊(個性、符合個性的英文名稱、工作內容)，Comment 到 Push Request
+2. 每個角色個別分析 Git Diff 的內容產生新問題表格(問題等級、角色名稱、問題位置或行數、修改建議)
+3. 讀取所有未解決的舊問題(問題檔案存在於使用此 Action 的專案固定位置)加上新問題後，去除重複產生本次 Push Request 的問題表格(PR問題表格)覆蓋問題檔案
+4. 從PR問題表格中取出所有舊問題，依照等級排序後 Comment 到 Push Request
+5. 從PR問題表格中取出所有新問題，排除嚴重等級的問題後 Comment 到 Push Request
+6. 從PR問題表格中取出所有新問題，將每個嚴重等級的問題 Comment 到 Push Request
+
+# 使用說明
+
+1. 在 Gitea 專案中建立 `.gitea/workflows` 資料夾
+2. 在 `.gitea/workflows` 資料夾中建立 `ai-review.yaml'
+3. 在 `ai-review.yaml` 中填入以下內容：
+
+如果服務提供者是 OpenRouter
+
+```yaml
+name: AI
+on:
+  pull_request:
+    types: [opened, synchronize]
+jobs:
+  code-review:
+    name: 'Code Review'
+    runs-on: ubuntu
+    steps:
+    - name: AI Code Review
+      uses: https://gitea.jsc.idv.tw/jiantw83/code-review@${{ vars.ACTION_CODE_REVIEW_VERSION }}
+      with:
+        OPENAI_API_KEY: ${{ secrets.OPEN_ROUTER_TOKEN }}
+    permissions:
+      contents: write
+      pull-requests: write
+      issues: write
+```
+
+如果服務提供者是 Ollama
+
+```yaml
+name: AI
+on:
+  pull_request:
+    types: [opened, synchronize]
+jobs:
+  code-review:
+    name: 'Code Review'
+    runs-on: ubuntu
+    steps:
+    - name: AI Code Review
+        uses: https://gitea.jsc.idv.tw/jiantw83/code-review@${{ vars.ACTION_CODE_REVIEW_VERSION }}
+        with:
+          OLLAMA_BASE_URL: ${{ secrets.OLLAMA_BASE_URL }}
+          OLLAMA_MODEL: ${{ secrets.OLLAMA_MODEL }}
+    permissions:
+      contents: write
+      pull-requests: write
+      issues: write
+```
\ No newline at end of file