外链与大文件规范
目标:大文件不进入 Git 仓库,但过程仍然有清晰记录。
外链登记文件命名方式见 文件命名与目录规范。
1. 哪些文件不要提交到 Git
以下文件不要直接提交:
- 大于 5MB 的 CSV、XLSX、ZIP、PARQUET
- 大数据集原文件
- 大于 100MB 的视频
- 压缩包
- 软件缓存目录
- Python 虚拟环境
__pycache__node_modules
2. 大文件怎么提交
大文件上传到指定外部平台,然后把链接写入仓库中的 Markdown 文件。
仓库记录的是:
- 谁登记了链接
- 什么时间登记
- 文件用途
- 文件版本
- 当前有效版本和历史版本
3. 推荐登记方式
每个人维护自己的外链登记文件。
示例:
其他/外链登记/LZ-组1_张三_外链登记.md
答辩/外链登记/LZ-组1_张三_答辩外链登记.md
组长后期可以把个人登记整合成总表,但不要删除个人登记文件。
4. 当前有效版本
当前有效版本只放最终正在使用的链接。
## 当前有效版本
| 文件 | 负责人 | 版本 | 链接 | 提取码 | 更新时间 | 说明 |
|---|---|---|---|---|---|---|
| LZ-组1_成果演示视频_v2.mp4 | 张三 | v2 | https://example.com | 1234 | 2026-07-18 | 最终候选版 |
5. 历史版本
历史版本用于保留过程。
## 历史版本
| 文件 | 负责人 | 版本 | 链接 | 提取码 | 更新时间 | 说明 |
|---|---|---|---|---|---|---|
| LZ-组1_成果演示视频_v1.mp4 | 张三 | v1 | https://example.com | 1234 | 2026-07-17 | 初版 |
6. 更新外链时怎么提交
更新外链后,自己 Commit 和 Push。
提交说明示例:
docs: 张三 登记成果演示视频v1外链
docs: 张三 更新成果演示视频v2外链
docs: 李四 登记数据样本外链
7. 不允许的做法
- 把大数据集直接提交进 Git。
- 只在微信群发外链,不写入仓库。
- 用“最终链接”“新链接”这类模糊描述。
- 删除历史版本但不说明原因。
- 用别人的账号登记自己的外链。
- 把外链只写进总报告,不写入自己的外链登记文件。