# DevFlow 提交规范 ## 提交注释格式 ``` <动词>: <简短描述> <详细说明(可选,仅在需要补充上下文时)> ``` ## 动词词表 | 动词 | 使用场景 | |------|---------| | `新增` | 新功能、新特性、新文件 | | `修复` | Bug 修复、问题修正 | | `更新` | 文档更新、配置变更、依赖升级、非功能性的已有内容修改 | | `重构` | 代码重构(行为不变的结构调整) | | `删除` | 移除功能、删除文件 | | `优化` | 性能优化、体验改进 | | `合并` | 分支合并 | ## 规范要求 1. **动词 + 冒号 + 空格**:`修复: 审批按钮永久转圈` 2. **主题行不超过 72 字符** 3. **主语用中文**,描述清楚改动内容 4. **不要用内部代号**:禁止 Batch/P1/P2/L1/F-XX 等代号 5. **不要用分隔线**:禁止 `---` 或 `===` 等装饰线 6. **不要写无意义提交**:如"更新"、"修复"、"提交"等无法看出内容的单字提交 7. **改动较多的提交**:主题行概括后,空一行用列表展开具体条目 8. **文档和代码合并提交**:文档更新和对应代码改动放在同一个提交中,不分散 ## 示例 ``` 修复: 审批按钮永久转圈和等待计数不停 ``` ``` 新增: 文件浏览器增强(窗口分离/Git 变更/行号/Diff/分页提交历史) - 窗口分离: FileExplorer 可弹出独立 Tauri 窗口 - 行号显示: 文件预览左侧显示行号列 - Diff 视图: 有 Git 变更的文件可切换 diff 红绿视图 - 提交详情: 点击提交查看变更文件列表及文件级 diff - 中文编码修复: git 命令注入 LC_ALL 环境变量 ```