forked from Gitconomy/Git4GenThinking
|
|
||
|---|---|---|
| .. | ||
| Assignment-M01 | ||
| Assignment-M02 | ||
| Assignment-M03 | ||
| Assignment-M04 | ||
| Assignment-M05 | ||
| Assignment-M06 | ||
| Assignment-M07 | ||
| README.md | ||
README.md
学员作业提交的工作空间
📌 这里是每个小组的 作品仓库,所有与课程相关的作业、实验结果、项目交付物,统一存放在本目录。
1. 目录用途说明
08-Workspace/ 是本课程学员提交课后练习内容的目录,用于:
- 提交各模块的课堂练习与作业;
- 存放小组项目的中间版本与最终交付物;
- 记录实验日志、Prompt 迭代记录、工作流草图等。
2. 基本组织结构(按模块分区)
所有作业按模块进行归档,一门课一个模块一个子目录,推荐结构为:
08-Workspace/
├── Assignment-M01/ # 第一课/模块一作业与练习
├── Assignment-M02/ # 第二课/模块一作业与练习
├── Assignment-M03/ # 第三课/模块一作业与练习
├── Assignment-M04/ # 第四课/模块一作业与练习
├── Assignment-M05/ # 第五课/模块一作业与练习
├── Assignment-M06/ # 第六课/模块一作业与练习
└── Assignment-M07/ # 第七课/模块一作业与练习
3. 小组作业命名规范
3.1 文件命名原则
统一采用:
<GroupName>-<ArtifactName>.md
示例:
银河护卫队-MVW.md(第二章:最小可行工作流)AlphaTeam-Structured-Input.md(第三章:结构化输入笔记)StarBuilders-Agent-Config.md(智能体配置说明)
命名要求:
<GroupName>使用你们在课程中统一报备的小组名称;- 文件名尽量用 中文小组名 + 简短英文/中文描述;
- 不要使用空格,可使用中划线
-连接; - 一个小组在同一模块下 原则上只保留一个最终版本文件。
3.2 模块内推荐结构(以 M02 为例)
08-Workspace/
└── Assigment-M02/
└── 银河护卫队-MVW.md
4. 协作与提交流程(Fork → 修改 → PR)
本课程采用接近真实开源项目的协作模式(参见仓库根目录 README)。推荐流程:
-
Fork 仓库
- 由小组长 Fork 课程主仓库到自己的 GitLink 账号下。
-
Clone 到本地
- 小组成员从队长仓库 Clone,一起在
08-Workspace/下工作。
- 小组成员从队长仓库 Clone,一起在
-
在对应模块目录新增或修改文件
- 确保路径正确,例如:
08-Workspace/M02-Workflow/银河护卫队-MVW.md
- 确保路径正确,例如:
-
Commit 信息规范
建议使用以下格式:
[M02] 银河护卫队 提交 MVW 初稿 [M02] 银河护卫队 更新 MVW 互评后版本 [M03] AlphaTeam 提交结构化输入笔记 -
Push 到队长仓库
git push origin main # 或者是你们约定使用的开发分支 -
由队长向课程主仓库发起 Pull Request
PR 标题规范:
[银河护卫队] 提交 M02 MVW 最终成果PR 内容建议包含:
- 本次提交涉及的模块与文件路径;
- 主要变更内容(如:新增 MVW、根据 Issue 反馈迭代等);
- 对应的 Issue 链接(如果有互评)。
5. Issue 与互评(推荐实践)
虽然作业最终以 PR 为准,但我们推荐使用 Issue 做中间互评与讨论:
- 在主仓库
Issues中,使用课程提供的 Issue 模板; - 标题示例:
[M02] 银河护卫队 提交 MVW 互评请求; - 文内附上你们在
08-Workspace/中的文件路径与关注点。
6. 注意事项
- 请不要在
08-Workspace/存放个人隐私数据、账号密码、API Key 等敏感信息; - 不要删除其他小组的目录或文件,如有命名冲突,请联系讲师;
- 所有内容默认以本课程采用的开源协议/知识共享协议对待(详见主仓库 LICENSE 说明)。
许可声明
本文档采用 知识共享署名--相同方式共享 4.0 国际许可协议 (CC BY--SA 4.0) 进行许可, © 2025 Gitconomy Research社区。