aigroup-workflow 2.2.1 → 2.2.2

package/docs/templates/api.md

@@ -1,157 +1,157 @@
-# API 结构化模板
-
-> 将接口文档转化为此格式
-
----
-
-## META
-```yaml
-模块: [模块名称]
-版本: v1.0
-基础路径: /api/v1
-认证: Bearer Token | Cookie | 无
-```
-
-## 接口清单
-
-| 方法 | 路径 | 说明 | 认证 |
-|------|------|------|------|
-| POST | /user/login | 用户登录 | ❌ |
-| GET | /user/info | 获取用户信息 | ✅ |
-| PUT | /user/update | 更新用户信息 | ✅ |
-
----
-
-## 接口详情
-
-### POST /user/login
-> 用户登录
-
-**请求**
-```json
-{
-  "username": "string, 必填, 用户名/手机号",
-  "password": "string, 必填, 密码MD5"
-}
-```
-
-**响应**
-```json
-{
-  "code": "number, 0=成功",
-  "data": {
-    "token": "string, JWT令牌",
-    "expires": "number, 过期时间戳"
-  },
-  "msg": "string, 错误信息"
-}
-```
-
-**错误码**
-| code | 说明 |
-|------|------|
-| 0 | 成功 |
-| 1001 | 用户名不存在 |
-| 1002 | 密码错误 |
-| 1003 | 账号已锁定 |
-
----
-
-### GET /user/info
-> 获取当前用户信息
-
-**请求头**
-```yaml
-Authorization: Bearer {token}
-```
-
-**请求参数**: 无
-
-**响应**
-```json
-{
-  "code": 0,
-  "data": {
-    "id": "number, 用户ID",
-    "username": "string, 用户名",
-    "avatar": "string, 头像URL",
-    "role": "string, admin|user",
-    "createdAt": "string, ISO时间"
-  }
-}
-```
-
----
-
-### PUT /user/update
-> 更新用户信息
-
-**请求**
-```json
-{
-  "nickname": "string, 可选, 昵称",
-  "avatar": "string, 可选, 头像URL",
-  "phone": "string, 可选, 手机号"
-}
-```
-
-**响应**
-```json
-{
-  "code": 0,
-  "msg": "更新成功"
-}
-```
-
----
-
-## 通用说明
-
-### 认证方式
-```
-请求头: Authorization: Bearer {token}
-过期时间: 7天
-刷新机制: 过期前1天可刷新
-```
-
-### 响应格式
-```json
-{
-  "code": "number, 0=成功, 非0=失败",
-  "data": "any, 业务数据",
-  "msg": "string, 提示信息"
-}
-```
-
-### 通用错误码
-| code | 说明 |
-|------|------|
-| 401 | 未登录/Token过期 |
-| 403 | 无权限 |
-| 500 | 服务器错误 |
-
-### 分页参数
-```yaml
-page: 页码, 从1开始
-size: 每页条数, 默认20
-```
-
-### 分页响应
-```json
-{
-  "list": [],
-  "total": "number, 总条数",
-  "page": "number, 当前页",
-  "size": "number, 每页条数"
-}
-```
-
----
-
-<!--
-转换指南:
-1. 每个字段标注类型+必填+说明
-2. 用示例值而非描述
-3. 错误码集中列出
-4. 通用规则提取到底部
--->
+# API 结构化模板
+
+> 将接口文档转化为此格式
+
+---
+
+## META
+```yaml
+模块: [模块名称]
+版本: v1.0
+基础路径: /api/v1
+认证: Bearer Token | Cookie | 无
+```
+
+## 接口清单
+
+| 方法 | 路径 | 说明 | 认证 |
+|------|------|------|------|
+| POST | /user/login | 用户登录 | ❌ |
+| GET | /user/info | 获取用户信息 | ✅ |
+| PUT | /user/update | 更新用户信息 | ✅ |
+
+---
+
+## 接口详情
+
+### POST /user/login
+> 用户登录
+
+**请求**
+```json
+{
+  "username": "string, 必填, 用户名/手机号",
+  "password": "string, 必填, 密码MD5"
+}
+```
+
+**响应**
+```json
+{
+  "code": "number, 0=成功",
+  "data": {
+    "token": "string, JWT令牌",
+    "expires": "number, 过期时间戳"
+  },
+  "msg": "string, 错误信息"
+}
+```
+
+**错误码**
+| code | 说明 |
+|------|------|
+| 0 | 成功 |
+| 1001 | 用户名不存在 |
+| 1002 | 密码错误 |
+| 1003 | 账号已锁定 |
+
+---
+
+### GET /user/info
+> 获取当前用户信息
+
+**请求头**
+```yaml
+Authorization: Bearer {token}
+```
+
+**请求参数**: 无
+
+**响应**
+```json
+{
+  "code": 0,
+  "data": {
+    "id": "number, 用户ID",
+    "username": "string, 用户名",
+    "avatar": "string, 头像URL",
+    "role": "string, admin|user",
+    "createdAt": "string, ISO时间"
+  }
+}
+```
+
+---
+
+### PUT /user/update
+> 更新用户信息
+
+**请求**
+```json
+{
+  "nickname": "string, 可选, 昵称",
+  "avatar": "string, 可选, 头像URL",
+  "phone": "string, 可选, 手机号"
+}
+```
+
+**响应**
+```json
+{
+  "code": 0,
+  "msg": "更新成功"
+}
+```
+
+---
+
+## 通用说明
+
+### 认证方式
+```
+请求头: Authorization: Bearer {token}
+过期时间: 7天
+刷新机制: 过期前1天可刷新
+```
+
+### 响应格式
+```json
+{
+  "code": "number, 0=成功, 非0=失败",
+  "data": "any, 业务数据",
+  "msg": "string, 提示信息"
+}
+```
+
+### 通用错误码
+| code | 说明 |
+|------|------|
+| 401 | 未登录/Token过期 |
+| 403 | 无权限 |
+| 500 | 服务器错误 |
+
+### 分页参数
+```yaml
+page: 页码, 从1开始
+size: 每页条数, 默认20
+```
+
+### 分页响应
+```json
+{
+  "list": [],
+  "total": "number, 总条数",
+  "page": "number, 当前页",
+  "size": "number, 每页条数"
+}
+```
+
+---
+
+<!--
+转换指南:
+1. 每个字段标注类型+必填+说明
+2. 用示例值而非描述
+3. 错误码集中列出
+4. 通用规则提取到底部
+-->

package/docs/templates/bug.md

@@ -1,62 +1,62 @@
-# BUG 结构化模板
-
-> 简洁高效的Bug报告格式
-
----
-
-## BUG-[YYYYMMDD]-[序号]
-
-```yaml
-标题: [一句话描述]
-级别: P0紧急|P1高|P2中|P3低
-状态: 待修|修复中|待验|已关
-发现: [姓名] @ YYYY-MM-DD
-指派: [开发姓名]
-```
-
-### 现象
-<!-- 发生了什么 -->
-[简述问题现象]
-
-### 复现
-```
-环境: [浏览器/系统/版本]
-账号: [测试账号，如有]
-步骤:
-1. [操作1]
-2. [操作2]
-3. [操作3]
-结果: [实际结果]
-期望: [期望结果]
-```
-
-### 证据
-<!-- 截图描述或日志关键行 -->
-```
-[错误日志/截图描述]
-```
-
-### 影响
-```yaml
-范围: [影响的功能/用户群]
-频率: 必现|偶现(X/10)
-```
-
-### 修复
-<!-- 修复后填写 -->
-```yaml
-原因: [根本原因]
-方案: [修复方案]
-文件: [修改的文件]
-验证: [如何验证]
-```
-
----
-
-<!--
-模板使用:
-- P0: 阻塞核心流程，立即修复
-- P1: 功能异常，当天修复
-- P2: 体验问题，本周修复
-- P3: 优化建议，排期处理
--->
+# BUG 结构化模板
+
+> 简洁高效的Bug报告格式
+
+---
+
+## BUG-[YYYYMMDD]-[序号]
+
+```yaml
+标题: [一句话描述]
+级别: P0紧急|P1高|P2中|P3低
+状态: 待修|修复中|待验|已关
+发现: [姓名] @ YYYY-MM-DD
+指派: [开发姓名]
+```
+
+### 现象
+<!-- 发生了什么 -->
+[简述问题现象]
+
+### 复现
+```
+环境: [浏览器/系统/版本]
+账号: [测试账号，如有]
+步骤:
+1. [操作1]
+2. [操作2]
+3. [操作3]
+结果: [实际结果]
+期望: [期望结果]
+```
+
+### 证据
+<!-- 截图描述或日志关键行 -->
+```
+[错误日志/截图描述]
+```
+
+### 影响
+```yaml
+范围: [影响的功能/用户群]
+频率: 必现|偶现(X/10)
+```
+
+### 修复
+<!-- 修复后填写 -->
+```yaml
+原因: [根本原因]
+方案: [修复方案]
+文件: [修改的文件]
+验证: [如何验证]
+```
+
+---
+
+<!--
+模板使用:
+- P0: 阻塞核心流程，立即修复
+- P1: 功能异常，当天修复
+- P2: 体验问题，本周修复
+- P3: 优化建议，排期处理
+-->

package/docs/templates/code-review.md

@@ -1,88 +1,88 @@
-# 审查报告
-
-<!--
-META:
-  type: code-review
-  date: YYYY-MM-DD
+# 审查报告
+
+<!--
+META:
+  type: code-review
+  date: YYYY-MM-DD
   author: code-reviewer
-  stage: Stage 1 / Stage 2 / 整体审查
--->
-
-## 基本信息
-
-| 字段 | 内容 |
-|------|------|
-| **审查阶段** | Stage 1（规格符合性）/ Stage 2（代码质量）/ 整体审查 |
-| **审查对象** | [文件路径 / PR 链接 / git diff 范围] |
-| **对照文档** | [实现计划路径 / 需求文档路径] |
-| **审查结论** | **通过** / **不通过** |
-
----
-
-## Stage 1：规格符合性
-
-> 核心问题：代码是否忠实实现了计划/需求的每条要求？
-
-### 逐条核对
-
-| # | 需求/计划条目 | 实现状态 | 备注 |
-|---|-------------|---------|------|
-| 1 | [需求描述] | 已实现 / 遗漏 / 偏离 | [说明] |
-| 2 | [需求描述] | 已实现 / 遗漏 / 偏离 | [说明] |
-
-### 多做的部分（未要求的功能）
-
-| # | 文件 | 多余内容 | 建议 |
-|---|------|---------|------|
-| | | | 移除 / 保留并说明理由 |
-
-### 少做的部分（遗漏的需求）
-
-| # | 遗漏需求 | 影响 | 建议 |
-|---|---------|------|------|
-| | | | |
-
-### Stage 1 结论
-
-- [ ] **通过** — 所有需求已实现，无多余无遗漏
-- [ ] **不通过** — 存在以下问题需修复：[问题清单]
-
----
-
-## Stage 2：代码质量
-
-> 核心问题：实现是否干净、安全、可维护？
-
-（Stage 1 通过后才填写此部分）
-
-### 问题清单
-
-| # | 严重级别 | 文件:行号 | 问题描述 | 修复建议 |
-|---|---------|----------|---------|---------|
-| | Critical / Important / Minor | | | |
-
-### 检查维度
-
-- [ ] **可读性**：命名清晰、结构合理、注释充分
-- [ ] **安全性**：输入验证、权限检查、敏感信息处理
-- [ ] **性能**：无明显性能瓶颈
-- [ ] **测试**：测试覆盖充分、测试有意义
-- [ ] **错误处理**：异常处理完整
-- [ ] **代码规范**：符合项目既有风格
-
-### Stage 2 结论
-
-- [ ] **通过** — 代码质量达标
-- [ ] **不通过** — 存在以下问题需修复：[问题清单]
-
----
-
-## 验证证据
-
-```
-[自己运行的命令和实际输出]
-```
-
-## 总结
-
-[一段话总结审查结论和关键发现]
+  stage: Stage 1 / Stage 2 / 整体审查
+-->
+
+## 基本信息
+
+| 字段 | 内容 |
+|------|------|
+| **审查阶段** | Stage 1（规格符合性）/ Stage 2（代码质量）/ 整体审查 |
+| **审查对象** | [文件路径 / PR 链接 / git diff 范围] |
+| **对照文档** | [实现计划路径 / 需求文档路径] |
+| **审查结论** | **通过** / **不通过** |
+
+---
+
+## Stage 1：规格符合性
+
+> 核心问题：代码是否忠实实现了计划/需求的每条要求？
+
+### 逐条核对
+
+| # | 需求/计划条目 | 实现状态 | 备注 |
+|---|-------------|---------|------|
+| 1 | [需求描述] | 已实现 / 遗漏 / 偏离 | [说明] |
+| 2 | [需求描述] | 已实现 / 遗漏 / 偏离 | [说明] |
+
+### 多做的部分（未要求的功能）
+
+| # | 文件 | 多余内容 | 建议 |
+|---|------|---------|------|
+| | | | 移除 / 保留并说明理由 |
+
+### 少做的部分（遗漏的需求）
+
+| # | 遗漏需求 | 影响 | 建议 |
+|---|---------|------|------|
+| | | | |
+
+### Stage 1 结论
+
+- [ ] **通过** — 所有需求已实现，无多余无遗漏
+- [ ] **不通过** — 存在以下问题需修复：[问题清单]
+
+---
+
+## Stage 2：代码质量
+
+> 核心问题：实现是否干净、安全、可维护？
+
+（Stage 1 通过后才填写此部分）
+
+### 问题清单
+
+| # | 严重级别 | 文件:行号 | 问题描述 | 修复建议 |
+|---|---------|----------|---------|---------|
+| | Critical / Important / Minor | | | |
+
+### 检查维度
+
+- [ ] **可读性**：命名清晰、结构合理、注释充分
+- [ ] **安全性**：输入验证、权限检查、敏感信息处理
+- [ ] **性能**：无明显性能瓶颈
+- [ ] **测试**：测试覆盖充分、测试有意义
+- [ ] **错误处理**：异常处理完整
+- [ ] **代码规范**：符合项目既有风格
+
+### Stage 2 结论
+
+- [ ] **通过** — 代码质量达标
+- [ ] **不通过** — 存在以下问题需修复：[问题清单]
+
+---
+
+## 验证证据
+
+```
+[自己运行的命令和实际输出]
+```
+
+## 总结
+
+[一段话总结审查结论和关键发现]