Skip to content

Commit 2fca249

Browse files
committed
feat: ensure submodules on task start
1 parent 54f792f commit 2fca249

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Git Submodule Check Rule
2+
3+
在执行任何开发任务之前,必须先检查并加载所有的 Git Submodules。
4+
5+
## 执行时机
6+
7+
在开始任何任务之前,必须先执行此检查,包括但不限于:
8+
- 代码开发或修改
9+
- 运行测试
10+
- 构建项目
11+
- 代码审查
12+
- 文档生成
13+
14+
## 检查步骤
15+
16+
1. **检查 `.gitmodules` 文件是否存在**
17+
- 如果文件不存在,说明项目没有使用 submodules,可以跳过后续步骤
18+
19+
2. **初始化并更新 submodules**
20+
- 如果 `.gitmodules` 文件存在,执行以下命令:
21+
```bash
22+
git submodule update --init --recursive --depth 1
23+
```
24+
25+
## 注意事项
26+
27+
- 使用 `--depth 1` 参数进行浅克隆,以减少克隆时间和存储空间
28+
- 如果 submodule 初始化失败,需要先向用户报告错误,等待用户处理后再继续任务
29+
- 此检查应在任务开始阶段尽早完成,避免因缺少 submodule 依赖导致后续任务失败

0 commit comments

Comments
 (0)