diff --git a/00-7-Day-Passport-Course/README.md b/00-7-Day-Passport-Course/README.md index ddb6173..78342bd 100644 --- a/00-7-Day-Passport-Course/README.md +++ b/00-7-Day-Passport-Course/README.md @@ -72,6 +72,7 @@ ├── resources/ ← 辅助资源文件夹 │ ├── passport_sample_cn.md ← 数字能力护照样张 │ ├── commit_prefix_cheat_sheet.md ← 提交前缀速查表 +│ ├── git_basic_concepts.md ← Git基本概念速查表 │ └── project_template_guide.md ← 模板文件夹使用指南 └── project-template/ ← 模板文件夹(Task02复制用) ├── README.md ← 项目首页示例 diff --git a/00-7-Day-Passport-Course/project_template_guide.md b/00-7-Day-Passport-Course/project_template_guide.md new file mode 100644 index 0000000..caaa921 --- /dev/null +++ b/00-7-Day-Passport-Course/project_template_guide.md @@ -0,0 +1,38 @@ +# 📂 project-template 模板文件夹使用指南 + +## 一、模板文件夹结构 + +``` +project-template/ ← Task02中你需要复制到小组仓库的文件夹 +├── README.md ← 【必须修改】项目首页 +├── report/ ← 文档目录 +│ └── collaboration_practice.md ← 【必须保留】Task03协作文件 +├── code/ ← 代码目录 +│ └── example_analysis.py ← 【可替换】示例代码文件 +├── data/ ← 数据目录 +│ └── sample_data.csv ← 【可替换】示例数据文件 +└── figures/ ← 图表目录 + └── sample_chart.png ← 【可替换】示例图片文件 +``` + +## 二、每个文件的作用 + +| 文件 | 作用 | Task02中如何处理 | Task03中是否用到 | +| :--------------------------------- | :--------------------------------- | :----------------------------------------- | :--------------: | +| `README.md` | 项目首页:团队名称、成员、项目简介 | **必须修改**:将示例内容替换为你的团队信息 | 否 | +| `report/collaboration_practice.md` | Task03协作核心文件 | **必须保留**:Task03需要在此文件上协作 | ✅ **是** | +| `code/example_analysis.py` | 保证目录可被Git跟踪 | **可替换或保留**:后续可替换为你的代码 | 否 | +| `data/sample_data.csv` | 保证目录可被Git跟踪 | **可替换或保留**:后续可替换为你的数据 | 否 | +| `figures/sample_chart.png` | 保证目录可被Git跟踪 | **可替换或保留**:后续可替换为你的图表 | 否 | + +## 三、关键规范 + +| 规范项 | 标准 | +| :--------------- | :---------------------------------------------------- | +| **协作分支** | 所有操作在 `master` 分支 | +| **首次提交信息** | `init: 初始化项目目录结构` | +| **目录结构** | `report/` `code/` `data/` `figures/` 四个目录不可缺失 | + +## 四、一句话总结 + +> **你不需要自己创建目录——Copy模板文件夹即可。只需修改README.md中的团队信息,提交信息统一为`init: 初始化项目目录结构`。示例文件后续可替换,当前作用仅是保证目录能被Git跟踪** \ No newline at end of file