Skip to content

tutorial.md

Latest commit

 

History

History
108 lines (75 loc) · 4.91 KB

tutorial.md

File metadata and controls

108 lines (75 loc) · 4.91 KB
Raw

🛡️ 如何成为本仓库的贡献者（Contributor）

什么是"贡献者"？ 在《大模型安全与知识增强》课程实验仓库中，"贡献者"指的是 成功提交实验报告并被合并（merge）的同学。当你的 Pull Request 被老师或助教 review 通过并合并后，你将正式成为本仓库的贡献者（Contributors 列表中会出现你的 GitHub 头像和姓名），这是一份可写入简历的真实开源协作经历 🚀

以下是从零开始的完整提交流程（即使你之前从未使用过 GitHub 也无需担心）：

1️⃣ 注册 / 登录 GitHub 账号

  • 访问 https://github.com
  • 若尚无账号，点击 Sign up 免费注册（推荐使用学校邮箱，便于后续认证学生身份并获取 GitHub Education 等免费资源）。

2️⃣ Fork 本仓库到你的账号下

  • 打开本仓库主页：https://github.com/wuhuanga/LLM-Safety-Course
  • 点击右上角的 Fork 按钮。
  • 选择 fork 到你自己的账号下。
  • 完成后你将拥有一份完全属于你自己的副本仓库，例如：https://github.com/你的用户名/LLM-Safety-Course。

3️⃣ 克隆仓库到本地（推荐方式）

# 请将下方 URL 替换为你 Fork 后的仓库地址
git clone https://github.com/你的用户名/LLM-Safety-Course.git
cd LLM-Safety-Course

若你不希望进行本地操作，也可使用 GitHub 网页版直接编辑文件（详见第 5 步的方法 B）。

4️⃣ 选择实验方向并准备提交文件

  • 浏览仓库根目录，进入你感兴趣的实验项目文件夹。
  • 仔细阅读该实验项目下的说明文档，理解实验目标与具体要求。
  • 在你自己的本地环境或独立代码仓库中完成实验开发。
  • 撰写最终实验报告，文件命名严格遵循以下格式： 学号-姓名-方向编号-方向简称.md 示例： 20231234-张三-02-RAG.md

⚠️ 安全提醒：报告与代码中切勿包含 API Key、个人 Token 或任何敏感凭证。提交前请检查 .env、config.yaml 等配置文件是否被误推送。

5️⃣ 将报告添加到仓库

  • 方法 A：本地提交（推荐，适合大文件或多文件场景）

    • 将报告文件放入对应实验项目的目录下。
    • 在终端依次执行：
    git add .
git commit -m "提交最终实验报告"
git push origin main

  • 方法 B：GitHub 网页直接上传（适合单文件提交）

    • 进入你 fork 的仓库主页。
    • 导航到对应实验项目的目录。
    • 点击 Add file → Upload files。
    • 拖拽或选择你的报告文件。
    • 在下方填写 commit 说明，点击 Commit changes。

6️⃣ 提交 Pull Request（PR）—— 最关键的一步

  • 回到你 fork 的仓库主页。

  • 你将看到一条黄色提示条：Compare & pull request。

  • 点击它，或手动选择 Contribute → Open pull request。

  • PR 标题须严格遵循以下格式： 示例：[最终作业] 20231234 张三 - RAG - 医疗领域知识增强问答系统 示例：[最终作业] 20231234 李四 - 红蓝对抗 - 面向中文大模型的越狱攻击检测框架

  • 在描述区填写以下内容：

    • 你的独立代码仓库链接（强烈推荐）。
    • Demo 链接或视频演示（如有）。
    • 主要成果与创新点。
    • 实验中使用的模型与简要思路说明。
    • 其他需要补充的内容。

  • 点击 Create pull request 完成提交。

7️⃣ 等待 Review 与合并

  • 老师 / 助教将对你的 PR 进行审查。

  • 若需修改，将在 PR 评论区留言反馈，你只需继续向同一分支推送新 commit 即可自动更新 PR。

  • 当 PR 通过 review 并被合并（merge）后：

    • 你的报告将正式出现在主仓库中。
    • 你将自动成为本仓库的 Contributor（可在仓库主页右侧 Contributors 列表中查看）。

💡 小贴士

  • 学期中可多次提交进度版 PR（标题前缀使用 [进度更新]），展示你的迭代过程，可作为加分项。
  • 在涉及对抗性提示词（Jailbreak）或攻击样本相关实验时，请严格遵守课程限定的测试范围，严禁针对线上商用模型发起未授权测试。
  • 第一次操作不熟悉是正常现象，建议先在测试分支多练习几次。
  • 遇到任何问题，可在仓库的 Issues 区提问，或在课堂上联系助教。

完成以上步骤，你的实验作业便正式提交，同时你也成为了本课程仓库的贡献者。这不仅是一次作业提交，更是一份可写入简历的真实开源协作经历 🛡️

期待在 Contributors 列表中看到你的贡献，加油！