@zhouhao4221/devflow-skills 0.3.6 → 0.3.7

package/plugins/req/templates/docker-compose.test.yml

@@ -0,0 +1,84 @@
+# 测试环境 Docker 配置模板
+# 复制到项目根目录并根据需要修改
+
+version: '3.8'
+
+services:
+  # MySQL 测试数据库
+  mysql-test:
+    image: ${MYSQL_TEST_IMAGE:-mysql:8.0}  # 可替换为预先创建的测试镜像
+    container_name: mysql-test
+    ports:
+      - "3307:3306"  # 使用不同端口避免与开发环境冲突
+    environment:
+      MYSQL_ROOT_PASSWORD: test123
+      MYSQL_DATABASE: test_db
+      MYSQL_USER: test_user
+      MYSQL_PASSWORD: test123
+    volumes:
+      - mysql-test-data:/var/lib/mysql
+      # 可挂载初始化脚本
+      # - ./tests/fixtures/init.sql:/docker-entrypoint-initdb.d/init.sql
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+    networks:
+      - test-network
+
+  # Redis 测试缓存
+  redis-test:
+    image: ${REDIS_TEST_IMAGE:-redis:7-alpine}  # 可替换为预先创建的测试镜像
+    container_name: redis-test
+    ports:
+      - "6380:6379"  # 使用不同端口避免与开发环境冲突
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+    networks:
+      - test-network
+
+volumes:
+  mysql-test-data:
+
+networks:
+  test-network:
+    driver: bridge
+
+# ===========================================
+# 使用说明
+# ===========================================
+#
+# 1. 启动测试环境：
+#    docker-compose -f docker-compose.test.yml up -d
+#
+# 2. 等待服务就绪：
+#    docker-compose -f docker-compose.test.yml ps
+#
+# 3. 查看日志：
+#    docker-compose -f docker-compose.test.yml logs -f
+#
+# 4. 停止并清理：
+#    docker-compose -f docker-compose.test.yml down -v
+#
+# 5. 使用自定义镜像：
+#    MYSQL_TEST_IMAGE=my-mysql-test:latest docker-compose -f docker-compose.test.yml up -d
+#
+# ===========================================
+# 测试数据库连接信息
+# ===========================================
+#
+# MySQL:
+#   Host: localhost
+#   Port: 3307
+#   Database: test_db
+#   User: test_user / root
+#   Password: test123
+#
+# Redis:
+#   Host: localhost
+#   Port: 6380
+#

package/plugins/req/templates/index-template.md

@@ -0,0 +1,60 @@
+# 需求索引
+
+> 自动生成，请勿手动编辑。更新时间：YYYY-MM-DD HH:MM
+
+---
+
+## 概览
+
+| 指标 | 数量 |
+|------|------|
+| 总需求数 | 0 |
+| 进行中 | 0 |
+| 已完成 | 0 |
+| 模块数 | 0 |
+
+---
+
+## 按状态
+
+### 开发中
+
+| 编号 | 标题 | 模块 | 进度 | 更新时间 |
+|------|------|------|------|----------|
+| - | - | - | - | - |
+
+### 待评审
+
+| 编号 | 标题 | 模块 | 创建时间 |
+|------|------|------|----------|
+| - | - | - | - |
+
+### 草稿
+
+| 编号 | 标题 | 模块 | 创建时间 |
+|------|------|------|----------|
+| - | - | - | - |
+
+### 已完成（最近 10 条）
+
+| 编号 | 标题 | 模块 | 完成时间 |
+|------|------|------|----------|
+| - | - | - | - |
+
+---
+
+## 按模块
+
+### 模块名称
+
+| 编号 | 标题 | 状态 | 更新时间 |
+|------|------|------|----------|
+| REQ-XXX | 需求标题 | 开发中 | YYYY-MM-DD |
+
+---
+
+## 快速导航
+
+- [模块文档](./modules/)
+- [进行中需求](./active/)
+- [已完成需求](./completed/)

package/plugins/req/templates/module-template.md

@@ -0,0 +1,79 @@
+# 模块名称
+
+## 概述
+
+简要描述模块的核心职责和业务范围。
+
+---
+
+## 核心功能
+
+> 按需求状态标记：已完成 | 开发中 | 规划中
+
+| 功能 | 需求编号 | 状态 | 说明 |
+|------|----------|------|------|
+| 功能1 | REQ-XXX | 已完成 | 简要说明 |
+| 功能2 | REQ-XXX | 开发中 | 简要说明 |
+
+---
+
+## 业务规则
+
+| 规则 | 说明 |
+|------|------|
+| 规则1 | 详细说明 |
+| 规则2 | 详细说明 |
+
+---
+
+## 数据模型
+
+### 核心表
+
+| 表名 | 说明 |
+|------|------|
+| `table_name` | 表用途说明 |
+
+### 表关系
+
+```
+表A --1:N-- 表B --N:M-- 表C
+```
+
+---
+
+## 关键文件
+
+| 层级 | 路径 | 说明 |
+|------|------|------|
+| Model | `internal/xxx/model/` | 数据模型 |
+| Store | `internal/xxx/store/` | 数据访问 |
+| Biz | `internal/xxx/biz/` | 业务逻辑 |
+| Ctrl | `internal/xxx/controller/` | 接口控制器 |
+
+---
+
+## API 概览
+
+| 方法 | 路径 | 说明 |
+|------|------|------|
+| GET | `/api/v1/xxx` | 查询列表 |
+| POST | `/api/v1/xxx` | 创建 |
+| PUT | `/api/v1/xxx/:id` | 更新 |
+| DELETE | `/api/v1/xxx/:id` | 删除 |
+
+---
+
+## 相关需求
+
+| 编号 | 标题 | 状态 | 更新时间 |
+|------|------|------|----------|
+| REQ-XXX | 需求标题 | 已完成 | YYYY-MM-DD |
+
+---
+
+## 变更记录
+
+| 日期 | 变更内容 |
+|------|----------|
+| YYYY-MM-DD | 初始版本 |

package/plugins/req/templates/prd-template.md

@@ -0,0 +1,338 @@
+# 产品需求文档 (PRD)
+
+| 字段 | 内容 |
+|-----|------|
+| 产品名称 | {{PROJECT_NAME}} |
+| 文档版本 | v1.0 |
+| 创建日期 | {{DATE}} |
+| 最后更新 | {{DATE}} |
+| 文档负责人 | |
+| 状态 | 草稿 / 评审中 / 已批准 |
+
+---
+
+## 修订历史
+
+| 版本 | 日期 | 修改人 | 修改内容 |
+|-----|------|-------|---------|
+| v1.0 | {{DATE}} | | 初始版本 |
+
+---
+
+## 1. 概述
+
+### 1.1 背景与问题
+
+> 描述当前存在的问题或机会，为什么需要这个产品
+
+**现状**：
+
+**问题**：
+
+**机会**：
+
+### 1.2 产品愿景
+
+> 用一句话描述产品的核心价值主张
+
+### 1.3 目标与成功指标
+
+> 定义可衡量的成功标准
+
+| 目标类型 | 指标 | 当前值 | 目标值 | 衡量方式 |
+|---------|-----|-------|-------|---------|
+| 业务目标 | | | | |
+| 用户目标 | | | | |
+| 技术目标 | | | | |
+
+### 1.4 范围定义
+
+**包含（In Scope）**：
+- 
+
+**不包含（Out of Scope）**：
+- 
+
+---
+
+## 2. 用户研究
+
+### 2.1 目标用户
+
+| 用户角色 | 用户特征 | 使用场景 | 核心痛点 | 期望收益 |
+|---------|---------|---------|---------|---------|
+| | | | | |
+
+### 2.2 用户旅程
+
+> 描述用户完成核心任务的完整流程。建议用 Mermaid `journey` 图，GitHub/Gitea 原生渲染。
+
+```mermaid
+%%{init: {'theme':'neutral'}}%%
+journey
+  title 用户核心任务旅程
+  section 阶段1
+    触点A: 3: 用户
+    触点B: 4: 用户
+  section 阶段2
+    触点C: 2: 用户
+    触点D: 5: 用户
+  section 阶段3
+    触点E: 4: 用户
+```
+
+> 分数表示用户情绪（1=糟糕，5=愉悦）。无 Mermaid 需求时可删除代码块，用文字描述。
+
+### 2.3 竞品分析
+
+| 竞品 | 优势 | 劣势 | 我们的差异化 |
+|-----|-----|-----|-------------|
+| | | | |
+
+---
+
+## 3. 功能需求
+
+### 3.1 功能概览
+
+| 优先级 | 功能模块 | 功能描述 | 用户价值 | MVP |
+|-------|---------|---------|---------|-----|
+| P0 | | | | 是 |
+| P1 | | | | 是/否 |
+| P2 | | | | 否 |
+
+### 3.2 功能详情
+
+#### 3.2.1 [功能模块名称]
+
+**功能描述**：
+
+**用户故事**：
+> 作为 [用户角色]，我希望 [功能行为]，以便 [获得价值]
+
+**功能流程**：
+
+```mermaid
+%%{init: {'theme':'neutral'}}%%
+flowchart LR
+  A[用户操作] --> B[系统响应]
+  B --> C[结果展示]
+```
+
+**业务规则**：
+- 规则1：
+- 规则2：
+
+**界面原型**：
+> 附上原型链接或截图
+
+**验收标准**：
+- [ ] 
+- [ ] 
+
+**边界情况**：
+| 场景 | 处理方式 |
+|-----|---------|
+| | |
+
+---
+
+## 4. 非功能需求
+
+### 4.1 性能需求
+
+| 场景 | 指标 | 目标值 | 测量方法 |
+|-----|-----|-------|---------|
+| 页面加载 | 首屏时间 | < 2s | |
+| API 响应 | P95 延迟 | < 200ms | |
+| 并发能力 | QPS | | |
+| 数据量 | 单表记录 | | |
+
+### 4.2 可用性需求
+
+- 系统可用性：99.9%
+- 计划内维护窗口：
+- 故障恢复时间（RTO）：
+- 数据恢复点（RPO）：
+
+### 4.3 安全需求
+
+| 类别 | 需求 | 优先级 |
+|-----|-----|-------|
+| 认证 | | P0 |
+| 授权 | | P0 |
+| 数据安全 | | P0 |
+| 审计日志 | | P1 |
+| 合规要求 | | |
+
+### 4.4 兼容性需求
+
+**Web 端**：
+- 浏览器：Chrome、Firefox、Safari、Edge（最新两个版本）
+
+**移动端**：
+- iOS：12.0+
+- Android：8.0+
+
+**其他**：
+- 屏幕分辨率：
+- 网络环境：
+
+---
+
+## 5. 数据需求
+
+### 5.1 数据模型
+
+> 描述核心数据实体及其关系
+
+| 实体 | 描述 | 关键字段 |
+|-----|-----|---------|
+| | | |
+
+### 5.2 数据采集
+
+| 数据点 | 采集时机 | 用途 | 保留期限 |
+|-------|---------|-----|---------|
+| | | | |
+
+### 5.3 数据报表
+
+| 报表名称 | 维度 | 指标 | 更新频率 |
+|---------|-----|-----|---------|
+| | | | |
+
+---
+
+## 6. 技术方案
+
+### 6.1 系统架构
+
+> 简要描述技术选型和整体架构
+
+**前端**：
+- 框架：
+- 状态管理：
+- UI 组件库：
+
+**后端**：
+- 语言/框架：
+- 数据库：
+- 缓存：
+- 消息队列：
+
+**基础设施**：
+- 部署方式：
+- 监控告警：
+- 日志系统：
+
+### 6.2 第三方依赖
+
+| 服务类型 | 服务商 | 用途 | 备选方案 |
+|---------|-------|-----|---------|
+| | | | |
+
+### 6.3 接口设计
+
+> 列出关键 API 接口
+
+| 接口 | 方法 | 描述 |
+|-----|-----|-----|
+| | | |
+
+---
+
+## 7. 发布计划
+
+### 7.1 版本规划
+
+| 版本 | 目标 | 核心功能 | 预计时间 |
+|-----|-----|---------|---------|
+| MVP | 验证核心假设 | | |
+| v1.0 | 正式上线 | | |
+| v1.x | 持续迭代 | | |
+
+### 7.2 里程碑
+
+| 里程碑 | 计划时间 | 实际时间 | 状态 | 备注 |
+|-------|---------|---------|-----|-----|
+| 需求评审通过 | | | 待开始 | |
+| 技术方案确定 | | | 待开始 | |
+| UI/UX 设计完成 | | | 待开始 | |
+| 开发完成 | | | 待开始 | |
+| 测试通过 | | | 待开始 | |
+| 上线发布 | | | 待开始 | |
+
+### 7.3 灰度策略
+
+> 描述上线的灰度发布计划
+
+---
+
+## 8. 风险管理
+
+### 8.1 风险识别
+
+| 风险 | 类型 | 可能性 | 影响 | 应对措施 | 负责人 |
+|-----|-----|-------|-----|---------|-------|
+| | 技术/业务/资源 | 高/中/低 | 高/中/低 | | |
+
+### 8.2 依赖项
+
+| 依赖项 | 类型 | 状态 | 风险 |
+|-------|-----|-----|-----|
+| | 内部/外部 | 已确认/待确认 | |
+
+### 8.3 假设与约束
+
+**假设**：
+- 
+
+**约束**：
+- 
+
+---
+
+## 9. 需求追踪
+
+> 本章节由 `/req:new` 和 `/req:done` 命令自动维护，记录所有从本 PRD 派生的需求。
+
+| 编号 | 标题 | 模块 | 状态 | 创建日期 | 完成日期 |
+|-----|------|------|------|---------|---------|
+| - | 暂无需求 | - | - | - | - |
+
+---
+
+## 10. 附录
+
+### 10.1 术语表
+
+| 术语 | 定义 |
+|-----|-----|
+| | |
+
+### 10.2 参考资料
+
+- 
+
+### 10.3 相关文档
+
+| 文档 | 链接 |
+|-----|-----|
+| 原型设计 | |
+| 技术方案 | |
+| 测试用例 | |
+
+---
+
+## 审批记录
+
+| 角色 | 姓名 | 意见 | 日期 |
+|-----|-----|-----|-----|
+| 产品负责人 | | | |
+| 技术负责人 | | | |
+| 业务负责人 | | | |
+
+---
+
+> 下一步：完善 PRD 后，可使用 `/req:new <标题>` 创建具体需求

package/plugins/req/templates/quick-template.md

@@ -0,0 +1,71 @@
+# QUICK-XXX 标题
+
+## 元信息
+
+| 字段 | 值 |
+|-----|-----|
+| 编号 | QUICK-XXX |
+| 改动类型 | bug修复 / 小功能 / 优化 |
+| 端类型 | 后端 / 前端 / 全栈 |
+| 状态 | 草稿 |
+| 模块 | - |
+| 优先级 | P2 |
+| 创建时间 | YYYY-MM-DD |
+| 负责人 | |
+| 关联需求 | - |
+| branch | - |
+| issue | - |
+
+## 生命周期
+
+- [x] 草稿
+- [ ] 方案确认
+- [ ] 开发中
+- [ ] 已完成
+
+---
+
+## 问题描述
+
+### 现象
+[描述问题现象或需求背景]
+
+### 期望
+[期望的正确行为或功能]
+
+---
+
+## 实现方案
+
+### 问题分析
+[问题根因分析]
+
+### 解决方案
+[具体的实现方案]
+
+### 涉及文件
+
+| 文件 | 改动类型 | 说明 |
+|-----|---------|------|
+| path/to/file.go | 修改 | [改动说明] |
+
+### 改动量
+- 预估：小 / 中
+- 涉及文件：X 个
+- 代码行数：约 XX 行
+
+---
+
+## 验证方式
+
+- [ ] [验证步骤1]
+- [ ] [验证步骤2]
+- [ ] 确认无副作用
+
+---
+
+## 开发记录
+
+### YYYY-MM-DD
+- 创建快速需求
+- [开发过程记录...]

package/plugins/req/templates/release-prompt-template.md

@@ -0,0 +1,51 @@
+# Release 配置
+
+> 本文件由 `/req:release` 在步骤 0 读取，注入项目特有的发版规则。
+> 删除不需要的章节即可——所有章节均为可选，缺失时使用插件默认行为。
+
+## 版本号文件
+
+> 版本号确定后（步骤 2），自动更新并暂存以下文件中的版本号字段。
+> 章节为空时跳过，不影响其他步骤。
+
+<!--
+示例：
+- `package.json` → `version`（直接写入本次 release 版本号，去掉 v 前缀）
+- `pyproject.toml` → `[project] version`
+- `src/version.go` → `const Version = "<version>"`
+-->
+
+## 发版前检查
+
+> 在生成任何产物（SQL 合并、changelog、commit）之前必须通过的检查。
+> 检查失败时硬停止，不继续执行后续步骤。
+
+<!--
+示例：
+- 运行测试：`npm test` / `go test ./...` / `pytest`
+- 构建验证：`npm run build`
+- Lint：`eslint src/`
+-->
+
+## 发版后步骤
+
+> Release 创建成功后执行（草稿模式下不执行，publish 后由人工触发）。
+> 仅输出提示，不自动执行副作用操作（通知、部署等由人工确认）。
+
+<!--
+示例：
+- 通知渠道：发版后在 #releases 频道 @ 团队
+- 部署：触发 staging 环境部署流水线
+- 文档：更新 docs 站点版本号
+-->
+
+## 额外附件
+
+> 除 SQL 文件外，需要上传到 Release 的其他文件或目录。
+> 支持 glob 模式，路径相对项目根目录。
+
+<!--
+示例：
+- `dist/app-*.zip`
+- `docs/api-spec.yaml`
+-->