Git & PR 图文教程

第一次用 Git？没关系，跟着这篇教程一步一步来。

前置准备

1. 安装 Git

• 下载：git-scm.com
• 安装时全部默认选项即可
• 验证安装：

git --version
# 输出类似：git version 2.45.0

2. 注册 AtomGit 账号

访问 AtomGit 注册账号，并加入比赛组织。

3. 配置 Git 身份

git config --global user.name "你的名字"
git config --global user.email "你的邮箱"

共创者赛道：Fork → 开发 → 提 PR

第 1 步：Fork 仓库

1. 打开 Yunque-Agent 主仓 页面
2. 点击右上角 Fork 按钮
3. 选择 Fork 到比赛组织下

第 2 步：克隆到本地

git clone https://atomgit.com/比赛组织/yunque-agent.git
cd yunque-agent

第 3 步：创建新分支

重要：不要直接在 main 分支上修改！

git checkout -b feat/my-awesome-skill

分支命名建议：

• 新功能/Skill：feat/功能名称
• 修复 Bug：fix/bug描述
• 文档：docs/文档名

第 4 步：开发

如果是创建 Skill

mkdir data/skills/my-skill

然后在 data/skills/my-skill/ 下创建 SKILL.md（参考 Skill 创作教程）

如果是修改代码

修改对应的文件即可。

第 5 步：查看改动

# 查看有哪些文件被修改了
git status

# 查看具体改了什么
git diff

第 6 步：提交

# 添加所有改动的文件
git add .

# 提交（写清楚做了什么）
git commit -m "feat(skill): 添加考试试卷生成器"

提交信息格式：

• feat(skill): 添加xxx — 新 Skill
• feat(ui): 添加xxx — 前端功能
• fix: 修复xxx — Bug 修复
• docs: 更新xxx — 文档

第 7 步：推送到远程

git push origin feat/my-awesome-skill

第 8 步：创建 Pull Request

1. 打开你的 Fork 仓库页面
2. 点击 New Pull Request 按钮
3. 选择 你的分支 → 主仓 main 分支
4. 填写 PR 描述（见下方模板）
5. 点击 Create Pull Request

PR 描述模板

## 做了什么

简要描述你的改动（1-2 句话）

## 为什么

解释为什么要做这个改动

## 改动内容

- [ ] 新增 Skill: `data/skills/exam-generator/`
- [ ] 包含 SKILL.md（核心指令）
- [ ] 包含 meta.json（元信息）

## 如何测试

1. 将 Skill 文件夹放入 `data/skills/`
2. 在技能页面点击扫描按钮
3. 在对话中输入相关关键词触发 Skill
4. 验证输出结果符合预期

## 截图

（贴上你在云雀中测试该功能的截图）

探索者赛道：创建仓库 → 提交作品

第 1 步：创建新仓库

1. 在比赛组织下点击 New Repository
2. 命名为 yunque-exploration-你的名字
3. 勾选 Initialize with README
4. 点击 Create

第 2 步：克隆到本地

git clone https://atomgit.com/比赛组织/yunque-exploration-你的名字.git
cd yunque-exploration-你的名字

第 3 步：编写作品

编辑 README.md，参考 体验报告编写指南。

截图放在 images/ 目录：

mkdir images
# 把截图复制到 images/ 目录下

在 README 中引用截图：

![截图描述](./images/screenshot-1.png)

第 4 步：提交并推送

git add .
git commit -m "docs: 提交云雀体验报告"
git push origin main

常见问题

Q: git push 报错 Permission denied A: 检查是否已配置 SSH Key 或 HTTPS 凭证。在 AtomGit 设置中添加 SSH 公钥。

Q: 怎么生成 SSH Key？

ssh-keygen -t ed25519 -C "你的邮箱"
# 一路回车，然后复制公钥
cat ~/.ssh/id_ed25519.pub

把输出的内容粘贴到 AtomGit 的 SSH Key 设置页面。

Q: 不小心在 main 分支上改了怎么办？

# 先保存改动
git stash
# 创建新分支
git checkout -b feat/my-feature
# 恢复改动
git stash pop

Q: 提交后发现写错了怎么办？

# 修改最近一次提交信息
git commit --amend -m "新的提交信息"

# 如果要加漏掉的文件
git add 漏掉的文件
git commit --amend --no-edit

Q: 可以用 VS Code 或 GitHub Desktop 吗？ A: 当然可以。用 GUI 工具也完全没问题。