ccg-workflow 2.1.16 → 3.0.1

package/templates/spec/backend/index.md

@@ -0,0 +1,31 @@
+# Backend Spec — 后端编码规范
+
+> 本文件定义后端代码的编码规范。子 Agent 在写代码前会自动读取此文件。
+> 按项目实际情况修改内容。
+
+## API 规范
+
+- 路由命名: RESTful, kebab-case
+- 请求/响应格式: JSON, camelCase fields
+- 错误格式: `{ "error": { "code": "...", "message": "..." } }`
+- 认证: Bearer token in Authorization header
+
+## 错误处理
+
+- 所有 API 端点必须返回结构化错误
+- 4xx: 客户端错误（验证失败、未授权等）
+- 5xx: 服务端错误（包装内部异常，不暴露堆栈）
+- 超时: 设置合理超时，超时后返回 504
+
+## 测试要求
+
+- 核心逻辑覆盖率 > 80%
+- API 端点必须有集成测试
+- 测试命名: `describe('模块') → it('should 行为')`
+
+## 安全清单
+
+- [ ] 输入验证（不信任任何用户输入）
+- [ ] SQL 参数化（禁止字符串拼接）
+- [ ] 密钥不硬编码（使用环境变量）
+- [ ] 敏感数据日志脱敏

package/templates/spec/frontend/index.md

@@ -0,0 +1,31 @@
+# Frontend Spec — 前端编码规范
+
+> 本文件定义前端代码的编码规范。子 Agent 在写代码前会自动读取此文件。
+> 按项目实际情况修改内容。
+
+## 组件规范
+
+- 组件命名: PascalCase
+- 文件结构: 一个组件一个文件
+- Props: TypeScript 接口定义，必须有类型
+- 状态: 优先 local state，跨组件共享用 store
+
+## 样式规范
+
+- 方案: CSS Modules / Tailwind / styled-components（按项目选择）
+- 命名: BEM 或 utility-first
+- 响应式: mobile-first
+- 主题: 使用 CSS 变量 / design tokens
+
+## 可访问性
+
+- [ ] 语义化 HTML（button 不用 div）
+- [ ] ARIA 标签（交互元素必须有 label）
+- [ ] 键盘导航（Tab 序和 Focus 管理）
+- [ ] 颜色对比度 > 4.5:1
+
+## 性能
+
+- 图片: 使用 lazy loading + 合适格式（WebP）
+- 包大小: 关注 bundle analyzer，避免大依赖
+- 渲染: 避免不必要的 re-render

package/templates/spec/guides/index.md

@@ -0,0 +1,30 @@
+# Guides — 跨模块开发指南
+
+> 本文件定义跨前后端的通用指南。适用于所有模块和子 Agent。
+> 按项目实际情况修改内容。
+
+## 架构原则
+
+- 单一职责: 每个模块/函数只做一件事
+- 依赖方向: 高层依赖低层，禁止循环
+- 接口优先: 跨模块通过接口通信，不直接访问内部
+
+## Git 提交规范
+
+- 格式: Conventional Commits (`feat:`, `fix:`, `refactor:`, `docs:`, `chore:`)
+- 原子提交: 一个逻辑变更一个 commit
+- 不提交: `.env`, `node_modules/`, 编译产物, IDE 配置
+
+## 代码审查清单
+
+- [ ] 变更是否符合需求？
+- [ ] 是否有测试覆盖？
+- [ ] 是否引入安全风险？
+- [ ] 是否有性能影响？
+- [ ] 命名是否清晰？
+
+## 文档要求
+
+- 公共 API 必须有类型注释
+- 复杂逻辑加注释说明 WHY（不是 WHAT）
+- 新模块需要 README