@newstarzj/cann-review 3.2.0 → 3.3.0

package/README.md

@@ -1,186 +1,235 @@
-# CANN 代码审查技能
+# CANN Code Review Skill 🔍
 
-自动审查 GitCode 上的 CANN 项目 PR，检查内存泄漏、安全漏洞和代码可读性。
+[![npm version](https://badge.fury.io/js/@newstarzj/cann-review.svg)](https://badge.fury.io/js/@newstarzj/cann-review)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## ✨ 特性
+🤖 **自动化代码审查技能 - 专为 CANN 项目设计**
 
-- 🔍 **全面代码审查**：内存泄漏、安全漏洞、代码可读性
-- 🚀 **基于 API**：使用 GitCode API，无需浏览器自动化，稳定可靠
-- 💬 **自动评论**：自动发布结构化审查报告
-- ✅ **LGTM 支持**：低风险 PR 自动发布 `/lgtm`
-- 🤖 **自动模式**：支持定时任务，自动审查新 PR
+自动分析 GitCode PR 代码变更，检查内存泄漏、安全漏洞和可读性，生成结构化报告并发布评论。
+
+## ✨ 核心功能
+
+- 🚀 **自动分析代码变更** - 使用 GitCode API 获取 PR 信息
+- 🔍 **全面质量检查** - 内存泄漏、安全漏洞、代码可读性
+- 📊 **结构化报告** - 清晰展示问题和改进建议
+- 💬 **自动发布评论** - 直接发布到 GitCode PR
+- ✅ **智能 LGTM** - 中低风险自动打上 `/lgtm` 标记
 
 ## 📦 安装
 
-### 1. 安装技能
+### 方式 1: npx 直接使用（推荐）
+
+无需安装，直接运行：
 
 ```bash
-clawhub install cann-review
+npx @newstarzj/cann-review
 ```
 
-### 2. 配置 GitCode API Token
-
-**首次使用必须配置 Token：**
+### 方式 2: 全局安装
 
 ```bash
-cd ~/.openclaw/workspace/skills/cann-review
-./gitcode-api.sh setup
+npm install -g @newstarzj/cann-review
+cann-review
 ```
 
-按提示输入你的 GitCode API Token。
-
-<details>
-<summary>📖 如何获取 Token？</summary>
+### 方式 3: 在 OpenCode 中使用
 
-1. 访问 https://gitcode.com/setting/token-classic
-2. 点击"生成新令牌"
-3. 选择权限：`api`, `write_repository`
-4. 复制生成的 Token
+将此技能复制到 OpenCode 的 skills 目录：
 
-</details>
+```bash
+# OpenCode 默认路径
+cp -r ./ ~/.opencode/skills/cann-review/
+```
 
-<details>
-<summary>🔧 其他配置方法</summary>
+## 🚀 快速开始
 
-**方法 2：手动配置**
+### 1. 配置 GitCode API Token
 
 ```bash
-cp config/gitcode.conf.example config/gitcode.conf
-nano config/gitcode.conf
-# 设置 GITCODE_API_TOKEN=your_token_here
+# 获取 Token: https://gitcode.com/setting/token-classic
+export GITCODE_API_TOKEN=your_token_here
+```
+
+### 2. 使用技能
+
+在 OpenCode 中：
+
+```
+审查这个 PR: https://gitcode.com/cann/runtime/merge_requests/628
 ```
 
-**方法 3：环境变量**
+或通过命令行：
 
 ```bash
-export GITCODE_API_TOKEN=your_token_here
+npx @newstarzj/cann-review "https://gitcode.com/cann/runtime/merge_requests/628"
 ```
 
-</details>
+## 📖 使用示例
 
-## 🚀 使用方法
+### 基本用法
 
-### 手动审查单个 PR
+```
+审查这个 PR: https://gitcode.com/cann/runtime/merge_requests/628
+```
 
-直接提供 PR 链接：
+### 仅检查安全问题
 
 ```
 审查这个 PR: https://gitcode.com/cann/runtime/merge_requests/628
+只检查安全漏洞
 ```
 
-或使用命令：
+### 禁用自动 LGTM
 
 ```
-cann review PR#628
+审查这个 PR: https://gitcode.com/cann/runtime/merge_requests/628
+不要自动打 lgtm
 ```
 
-### 自动审查模式
+## 🎯 审查报告示例
 
-配置定时任务，自动审查新 PR：
+```markdown
+## 🤖 CANN 代码审查报告
 
-```yaml
-# 在 OpenClaw 中配置 cron 任务
-schedule: "0 */2 * * *"  # 每 2 小时执行一次
-task: "cann-review auto"
-```
+**PR**: #628 - Fix memory leak in buffer allocation
+**严重性**: ✅ Low
+**审查时间**: 2026-03-12 21:30
 
-## 🔧 API 辅助脚本
+---
 
-提供了 `gitcode-api.sh` 辅助脚本：
+### 📊 审查结论
 
-```bash
-# 获取 PR 信息
-./gitcode-api.sh get-pr cann runtime 628
+**✅ 建议合入**
 
-# 获取 PR 文件变更
-./gitcode-api.sh get-files cann runtime 628
+- **严重性**: Low
+- **代码质量**: 良好
+- **内存安全**: ✅ 无风险
+- **安全性**: ✅ 无漏洞
 
-# 发布评论
-./gitcode-api.sh post-comment cann runtime 628 "LGTM!"
+代码质量良好，修复了内存泄漏问题，建议合入。
 
-# 列出开放的 PR
-./gitcode-api.sh list-prs cann runtime
-```
+---
 
-## 📊 审查报告格式
+### 🔍 详细检查
 
-审查报告包括：
+#### 1. 内存安全 ✅
+- **内存泄漏**: 已修复
+- **指针操作**: 安全
+- **资源管理**: RAII 模式
 
-- **审查结论**：严重性评估和建议
-- **修改概述**：变更文件和核心变更
-- **代码质量检查**：
-  - 内存安全
-  - 安全性
-  - 可读性
-  - 逻辑正确性
-- **改进建议**：具体优化建议
-- **代码亮点**：做得好的地方
+#### 2. 安全性 ✅
+- **边界检查**: 完整
+- **输入验证**: 完整
+- **潜在漏洞**: 无
 
-## ⚙️ 配置
+#### 3. 可读性 ✅
+- **代码清晰度**: 良好
+- **命名规范**: 符合
+- **注释完整性**: 部分
 
-### 配置文件
+---
 
-配置文件位于：`~/.openclaw/workspace/skills/cann-review/config/gitcode.conf`
+### 💡 改进建议
 
-```bash
-# 查看当前配置
-cat ~/.openclaw/workspace/skills/cann-review/config/gitcode.conf
-```
+1. **文档**: 为新增的内存管理类添加详细注释
+2. **测试**: 增加边界条件的单元测试
 
-### 环境变量（可选）
+---
 
-也可以通过环境变量配置：
+### ✅ 代码亮点
 
-```bash
-export GITCODE_API_TOKEN=your_token_here
-export GITCODE_API_BASE=https://api.gitcode.com/api/v5  # 可选
+- 使用 RAII 管理资源，避免内存泄漏
+- 错误处理完整，异常路径安全
+- 代码结构清晰，易于维护
+
+---
+
+**总体评价**: 高质量的内存管理修复，建议合入。
 ```
 
-### 重新配置
+## ⚙️ 配置选项
+
+| 选项 | 说明 | 默认值 |
+|------|------|--------|
+| `pr_url` | PR 页面链接（必需） | - |
+| `focus_areas` | 审查重点 (memory/security/readability/all) | all |
+| `auto_lgtm` | 中低风险自动 LGTM | true |
+
+## 🔧 高级配置
+
+创建配置文件 `~/.cann-review/config`：
 
 ```bash
-cd ~/.openclaw/workspace/skills/cann-review
-./gitcode-api.sh setup
+# GitCode API Token
+GITCODE_API_TOKEN=your_token_here
+
+# 审查超时时间（秒）
+REVIEW_TIMEOUT=300
+
+# 最大文件数
+MAX_FILES=100
 ```
 
-### 审查阈值
+## 📋 审查标准
+
+### 严重程度判定
+
+| 等级 | 条件 | 是否合入 | LGTM |
+|------|------|---------|------|
+| ✅ Low | 仅有建议性改进 | 可以 | 自动 |
+| ⚠️ Medium | 有一般性问题 | 建议修改后 | 自动 |
+| ❌ High | 有严重问题 | 需要修改 | 不发布 |
+| 🔴 Critical | 有安全漏洞或严重内存问题 | 需要修改 | 不发布 |
 
-可在技能中调整发布 LGTM 的阈值：
+### 检查项
 
-- `low`: 仅低风险发布 LGTM
-- `medium`: 低和中低风险发布 LGTM（默认）
-- `high`: 低、中、高风险都发布 LGTM（不推荐）
+#### 内存安全
+- 动态内存分配/释放配对
+- 异常路径资源释放
+- RAII 模式使用
+- 容器内存管理
 
-## 🐛 故障排查
+#### 安全性
+- 空指针检查
+- 数组边界检查
+- 安全函数使用
+- 整数溢出检查
 
-### API 返回 401
+#### 可读性
+- 命名清晰度
+- 注释完整性
+- 代码结构
+- 风格一致性
+
+## 🛠️ 开发
 
-检查 Token 是否有效：
 ```bash
-curl -H "Authorization: Bearer YOUR_TOKEN" https://api.gitcode.com/api/v5/user
-```
+# 克隆仓库
+git clone https://gitcode.com/your-repo/cann-review.git
 
-### 无法评论已合并的 PR
+# 安装依赖
+npm install
 
-这是正常行为，已合并的 PR 可能禁止新评论。
+# 测试
+npm test
 
-### API 频率限制
+# 发布
+npm publish
+```
 
-GitCode API 限制：50次/分钟，4000次/小时。如需大量审查，添加适当延迟。
+## 📄 License
 
-## 📝 版本历史
+MIT License - 详见 [LICENSE](LICENSE) 文件
 
-### v3.0.0 (2026-03-04)
-- 🎉 **重大更新**：全面改用 GitCode API
-- 🚀 提高稳定性和可靠性
-- 📝 简化操作流程
+## 🤝 贡献
 
-详细版本历史见 SKILL.md
+欢迎提交 Issue 和 Pull Request！
 
-## 📄 许可证
+## 📮 联系方式
 
-内部使用
+- GitCode: https://gitcode.com/your-repo/cann-review
+- Email: openclaw@gitcode.com
 
-## 🤝 贡献
+---
 
-如有问题或建议，请联系维护团队。
+**Made with ❤️ by OpenClaw Team**