docs(开发约定): 增加中文 Git 提交规范

2026-08-04 18:05:18 +08:00
parent 5e2d4e7aaf
commit add240775b
1 changed files with 35 additions and 0 deletions
@@ -0,0 +1,35 @@
+# 项目开发约定
+
+## Git 提交规范
+
+- 每个 `TASK-*` 或后续工单都必须在独立 worktree 和分支中开发。
+- 每个可验证的开发步骤完成后立即创建 Git 提交并推送到 Gitea `intelligrow` 组织下的对应远端分支，不得等第一版全部完成后再统一提交。
+- 提交信息使用中文描述，采用 Conventional Commits 常见前缀，格式为：
+
+  ```text
+  <type>(<scope>): <中文描述>
+  ```
+
+- `scope` 可选；描述应简短、明确，说明本次提交实际完成的内容，不写空泛描述。
+- 常用前缀：
+  - `feat`：新增功能
+  - `fix`：修复问题
+  - `docs`：文档修改
+  - `refactor`：重构，不改变外部行为
+  - `test`：新增或调整测试
+  - `perf`：性能优化
+  - `build`：构建或依赖调整
+  - `ci`：持续集成配置调整
+  - `style`：不影响逻辑的格式调整
+  - `chore`：其他维护工作
+  - `revert`：回滚提交
+- 任务提交应包含任务号或范围信息，推荐格式：
+
+  ```text
+  feat(WP7-05): 增加候选环境覆盖证据门禁
+  fix(WP5-04): 修复资源访问安全边界
+  test(WP5-lineage): 增加连续提交链验证
+  ```
+
+- 提交完成后必须核对本地提交 SHA、远端分支和远端完整 SHA；本地未提交、推送失败或远端 SHA 不一致时，不得宣告任务完成，也不得开始依赖该任务的下一项任务。
+- 不得在提交信息、日志、测试证据或代码中写入真实凭据、验证码、用户绝对路径或私有响应正文。