1. .gitignore:Git 的"屏蔽名单"
在自动驾驶项目中,数据集(.h5)可能几十 GB,模型权重(.pth)可能几百 MB。如果你把这些全传到 GitHub 上,服务器会瞬间崩溃。
-
作用 :告诉 Git 哪些文件不需要追踪和上传。
-
常见内容:
-
__pycache__/:Python 运行产生的缓存。 -
_datasets/:庞大的原始数据。 -
_logs/:训练产生的临时日志。 -
.env:包含私密密钥(如 API Key)的环境变量文件。
-
2. LICENSE:代码的"使用说明书"
这是一个法律文件,规定了别人可以如何使用、修改或分发你的代码。
-
作用:定义代码的版权归属和授权范围。
-
常见类型:
-
MIT:极其宽松,随便用,出事别找我(CoIL 项目通常用这个)。
-
Apache:允许使用,但对专利保护更友好。
-
GPL:如果你用了我的代码,你的项目也必须开源。
-
-
意义:没有 LICENSE 的代码在法律上默认是"版权所有",别人不敢随便用。
3. .vscode 文件夹:编辑器的"私人定制"
这是 VS Code 专用的配置文件夹,只对当前项目生效。
-
作用:存储项目的运行配置、调试参数和插件建议。
-
核心文件:
-
settings.json:比如指定这个项目必须用哪个 Python 虚拟环境,或者设置 LaTeX 的自动编译逻辑。 -
launch.json:最关键! 它定义了你按F5调试时的参数。比如你想调试drive.py,你可以在这里配好--host 127.0.0.1 --port 2000,以后一键就能启动,不用每次手打命令行。 -
extensions.json:推荐团队成员安装的插件,比如 GitHub Copilot。
-
4. .git 文件夹:仓库的"记忆中枢"
这是你在执行 git init 或 git clone 时自动生成的隐藏文件夹。
-
作用 :存储了项目所有的历史版本、分支信息、提交记录(Commits)和远程仓库地址。
-
警告 :千万不要手动修改或删除它! 一旦删除,你的项目就会从一个"有历史、有版本"的 Git 仓库退化成一个普通的文件夹,所有的历史记录都会灰飞烟灭。
-
逻辑 :你平时看到的那些
.py文件只是这个仓库的"当前状态",而.git文件夹里存着它从出生到现在的所有"前世今生"。
💡 总结对照表
| 名称 | 类型 | 核心作用 | 小白建议 |
|---|---|---|---|
.gitignore |
文件 | 过滤垃圾和超大文件 | 把 *.h5 和 *.pth 都写进去 |
LICENSE |
文件 | 法律授权声明 | 实习期间,尊重实验室的授权选择 |
.vscode |
文件夹 | VS Code 环境配置 | 检查 launch.json 来快速开启调试 |
.git |
文件夹 | 整个仓库的历史大脑 | 别碰它! 它是隐藏的,当它不存在就好 |
如果你现在想把你的修改提交到 GitHub,一定要先看一眼 .gitignore,确认你没有把几个 GB 的测试数据也顺手带上去。