docs 子项目自动化提交规则
适用范围: 仅 docs 子项目
本文件定义 docs 子项目的 Git 提交规则,与主项目不同,docs 采用宽松的自动化提交策略。
核心规则
docs 子项目可以自动完成提交和推送
触发条件
1. 明确指示
用户明确说明:
- "提交 docs"
- "都提交吧"
- "提交子项目"
2. 当前工作目录
当前工作目录为 docs/
提交流程
自动执行以下流程:
bash
# 1. 提交本地更改
git add .
git commit -m "提交信息"
# 2. 同步远程更新
git pull --rebase
# 或
git pull --no-rebase # 根据情况选择
# 3. 推送到远程
git push自动部署
推送到 main 分支会自动触发 GitHub Actions 部署:
- 构建时间: ~18秒
- 部署时间: ~10秒
- 访问地址: https://zhaoheng666.github.io/WTC-Docs/
默认行为
除非满足触发条件,否则不提交 docs
即使在"全部提交"场景中,也要等待主项目提交完成后再处理 docs。
提交信息规范
docs 子项目遵循与主项目相同的提交类型规范:
参考: Git 提交类型规范
常用类型:
docs: 更新 API 文档feat: 添加新的文档章节fix: 修复文档中的错误链接chore: 更新 VitePress 配置
注意事项
不添加 AI 标识
与主项目一致,docs 提交信息中也不包含 "Generated with Claude" 等 AI 相关标识。
简洁明了
提交信息应直接描述变更内容。
自动恢复 stash
提交推送完成后,如有 stash 会自动恢复。
对比:主项目 vs docs 子项目
| 项目 | 提交策略 | 确认流程 |
|---|---|---|
| 主项目 | 严格确认 | 必须生成大纲并明确询问 |
| docs 子项目 | 自动化 | 满足触发条件即可自动执行 |
最后更新: 2025-10-13 维护者: WTC-Docs Team