From db1c5c6bfd05a1112f9ea6b8bf37329c5ddde728 Mon Sep 17 00:00:00 2001 From: voson Date: Tue, 13 Jan 2026 11:21:36 +0800 Subject: [PATCH] =?UTF-8?q?refactor:=20=E7=B2=BE=E7=AE=80=E9=85=8D?= =?UTF-8?q?=E7=BD=AE=E6=96=87=E6=A1=A3=E5=92=8C=E9=A1=B9=E7=9B=AE=E8=AF=B4?= =?UTF-8?q?=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 81 +++++-------------------------------------------------- README.md | 21 +-------------- 2 files changed, 7 insertions(+), 95 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 2bc978c..f2ce276 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -59,28 +59,7 @@ --- -## 4. 开发规范 - -### Git 提交 -- 遵循 [Conventional Commits](https://www.conventionalcommits.org/) -- 格式：`(): `（中文） -- 类型：feat、fix、docs、style、refactor、test、chore、ci、build、perf -- 主分支：`main` - -详见 `skill/git/SKILL.md` - -### 代码风格（JavaScript/TypeScript） -- 缩进：2 空格 -- 分号：使用 -- 引号：双引号 -- 命名：camelCase、PascalCase、UPPER_SNAKE_CASE - -### 分支命名 -- `feature/描述`、`fix/描述`、`docs/描述` - ---- - -## 5. 批量修改策略 +## 4. 批量修改策略 **原则：先修改一个，验证通过后再批量修改** @@ -89,7 +68,6 @@ 2. 修改样本 3. 验证功能 4. 批量应用 -5. 最终验证 ### 例外 - 简单修改（如批量重命名） @@ -98,60 +76,13 @@ --- -## 6. 工具使用策略 +## 5. 代码质量 -| 工具 | 用途 | -|------|------| -| **Task** | 探索代码库、多步骤分析、全局搜索 | -| **Bash** | Git 操作、构建、测试命令 | -| **Read/Edit/Write** | 文件读写（不用 cat/sed/echo） | -| **Glob/Grep** | 文件查找和内容搜索 | -| **TodoWrite** | 任务管理（超过 3 步必须使用） | - ---- - -## 7. 任务管理 - -### TodoWrite 使用原则 -- 任务超过 3 步时创建 todo 列表 -- 立即标记完成（不批量完成） -- 同时只有 1 个 `in_progress` - -### 状态 -- `pending`、`in_progress`、`completed`、`cancelled` - ---- - -## 8. 代码质量 - -### 测试 -- 新功能必须包含测试 -- 覆盖率 ≥ 50% - -### 构建 +### 原则 +- 确保程序能够运行，需要用户手动运行的除外 - 类型检查零错误 -- 修复所有 Linter 警告 +- 尝试修复所有 Linter 警告 +- 允许存在 warning，但不允许存在 error ### 安全 - 不提交敏感信息（.env、密钥） -- 输入验证和输出编码 - ---- - -## 快速参考 - -| 场景 | 操作 | -|------|------| -| 用户说"创建文件" | 创建文件，**不自动提交** | -| 用户说"提交代码" | 可以执行 `git commit` | -| 用户使用 `/git-push` | 执行完整推送流程 | -| 创建超过 100 行的文件 | 只说明路径和用途，**不展示内容** | -| 命令输出已完整 | 直接展示，**不重复总结** | -| 批量修改 10 个文件 | 先改 1 个验证，再批量 | - ---- - -详细指南： -- Git 工作流：`skill/git/SKILL.md` -- Gitea 集成：`skill/gitea/SKILL.md` -- 开发规范：各 `skill/*/SKILL.md` diff --git a/README.md b/README.md index ef6bcb3..e76250e 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,20 @@ # OpenCode -OpenCode 是一个强大的交互式 CLI 工具，帮助开发者高效地完成软件工程任务。它提供智能化的命令、可复用的技能以及扩展插件，支持自动化工作流程。 ## 📊 项目统计 - **15 个 CLI 命令** - 涵盖 Git 和 Gitea 操作 - **7 个开发领域技能库** - Android、iOS、Go、Electron、MQTT 等 - **4 套 CI/CD 工作流模板** - 适配多种项目类型 -- **50+ 文档文件** - 完整的指南和参考资料 ## 🌟 核心特性 - **智能命令系统** - 自动生成提交信息、管理版本标签、安全地暂存文件 - **可复用技能** - 预定义的开发工作流，如 Git 工作流、Android 开发等 -- **插件扩展** - 支持自定义插件来扩展功能 - **安全优先** - 自动过滤敏感文件，防止意外泄露凭证 - **中文友好** - 完整的中文支持和交互提示 -## 📋 完整目录结构 +## 目录 ``` opencode/ @@ -86,19 +83,3 @@ opencode/ └── .gitignore # Git 忽略文件配置 ``` -### 目录说明 - -| 目录 | 用途 | 说明 | -|------|------|------| -| `command/` | CLI 命令 | 15 个内置命令，支持 Git、Gitea 等操作 | -| `skill/` | 开发指南 | 7 个开发领域的完整工作流程和最佳实践 | -| `skill/git/` | Git 工作流 | 提交规范、版本管理、Tag 规范等 | -| `skill/gitea/` | Gitea 集成 | 仓库、Runner、API、CI/CD Workflow 管理 | -| `skill/gitea/workflow-templates/` | 工作流模板 | 4 套预定义的 CI/CD Workflow 模板 | -| `skill/android-developer/` | Android 开发 | Kotlin、Jetpack Compose、MVVM 架构规范 | -| `skill/ios-developer/` | iOS 开发 | Swift、SwiftUI、iOS 26+ 最佳实践 | -| `skill/go-developer/` | Go 开发 | 后端开发规范、测试标准、质量工具 | -| `skill/electron-developer/` | Electron 开发 | TypeScript、Lit Web Components、跨平台实践 | -| `skill/mqtts-developer/` | MQTT 开发 | MQTT over TLS/SSL 协议、安全通信 | -| `plugin/` | 插件系统 | 扩展功能，支持自定义开发 | -