Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (92 loc) · 4.81 KB

CONTRIBUTING.md

File metadata and controls

124 lines (92 loc) · 4.81 KB
Raw

作业提交规则

1. 目录与命名

每位学员使用固定的 GitHub 用户名作为目录名，每课单独一个目录。

路径示例 内容
submissions/your-github-name/lesson-01/README.md 作业说明
submissions/your-github-name/lesson-01/index.html 单文件作品
submissions/your-github-name/lesson-01/preview.png 作品截图
submissions/your-github-name/lesson-01/assets/ 运行所需图片等素材（有则提交）
submissions/your-github-name/lesson-02/ 第二课成果

将 your-github-name 换成你的真实 GitHub 用户名。课次使用 lesson-01 至 lesson-06。 文件名优先使用英文、数字和短横线；昵称与正文可以使用中文。不要把作业放进 example 目录。

2. README 内容

复制下面模板，填写实际情况：

# 作品名称

- 学员昵称：
- GitHub 用户名：
- 课次：
- 完成状态：已完成／部分完成／暂时无法运行
- 在线体验：无，或填写链接
- 项目仓库：无，或填写链接

## 作品介绍
用两三句话说明作品做什么、如何交互。

## 本次完成
列出实际完成的功能。

## 如何运行
说明需要打开的文件、是否联网，以及必要操作。

## 当前问题
写出实际问题和复现步骤；没有则写“暂无已知问题”。

## 创作记录
- 使用工具：
- 我的主要修改或判断：
- 素材来源与许可：没有外部素材则注明

## 作品截图
![作品截图](preview.png)

## 展示意愿
- 可用于课程宣传：是／否（选择一项）
- 署名：

项目复杂时，可以只提交 README、截图及个人项目仓库链接、体验链接，不必重复上传完整工程。说明运行方法和对应的版本记录，便于日后回看本课成果。

3. Git 提交流程

首次：Fork 班级仓库 → clone 个人 Fork → 确认 origin 为个人 Fork、upstream 为班级仓库。

每课：

  1. 检查本地未提交修改，先妥善保存，不丢弃已有工作。
  2. fetch upstream，从其最新默认分支创建本课分支。
  3. 分支命名：submit/你的GitHub用户名/lesson-01。
  4. 只添加或修改本人本课目录内的文件。
  5. 检查差异，再 commit、push 到 origin。
  6. 向班级仓库默认分支创建 PR，填写模板。

默认分支通常为 main，以实际仓库为准。每课使用新分支，不从上一课尚未合并的作业分支开始。

PR 方向：base = 班级仓库默认分支；head = 个人 Fork 的本课分支。

提交标题示例：[第一课] 小林｜鼠标流光

PR 未合并时继续更新原分支即可，不重复开 PR。已合并后的修订，新建 submit/用户名/lesson-01-fix-01 等分支，并在新 PR 中引用原 PR。

4. 提交范围

  • 提交运行所需的源文件、必要素材、截图和说明。
  • 截图建议 PNG 或 JPG，单张控制在 2 MB 左右，兼顾文字清晰。
  • 大体积视频、模型、依赖包使用链接，不直接塞进作业仓库。
  • 不提交 .git、node_modules、缓存、日志、密钥、账号凭据或无关个人信息。
  • 不修改公共首页、提交规则、PR 模板或其他学员目录。
  • 不强制 push，不替老师合并 PR。遇到冲突先查看原因，必要时请老师协助。
  • 宣传意愿在作业 README 与 PR 中保持一致，未明确同意的按不同意处理。

5. 提交前检查

  • 作业位于本人本课目录。
  • README 信息完整，截图可以显示。
  • 运行方法已写明，未完成的地方已说明。
  • 链接可访问，素材来源已说明。
  • 改动没有涉及其他学员或公共文件。
  • 没有密钥、依赖目录和无关文件。

6. 可交给 AI 的提示词

把方括号替换成实际内容，再发送给你的编程助手：

请帮我提交本次课程作业。
班级源仓库：【链接】
我的 Fork：【链接】
本地提交仓库：【完整路径】
GitHub 用户名：【用户名】
课次：【lesson-01】
作品文件与截图：【位置】
学员昵称、作品名、完成情况、问题、宣传意愿及署名：【填写】

先阅读 README、CONTRIBUTING 和 PR 模板。
检查 Git 状态及 origin、upstream，保留所有未提交修改。
获取 upstream 最新状态，从其默认分支创建本课专用分支。
只把本次成果复制到 submissions/我的用户名/本课目录，
不要复制项目的 .git、依赖、密钥和临时文件。
如实填写作业 README，不虚构测试结果、链接或宣传意愿。
检查差异后 commit、push 到我的 Fork，
向班级源仓库默认分支创建 PR，不自动合并。
如果本次已有未合并 PR，则更新原分支，不重复创建。
完成后返回 PR 链接和本次提交文件列表。
遇到授权或访问问题时说明具体卡点，不宣称已完成。