16.5 提交 Pull Request

配套代码:code/chapter16

16.5.1 提交代码到 GitHub

步骤 1:检查修改

# 查看修改的文件
git status

步骤 2:添加文件

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

# 或者添加特定文件
git add Co-creation-projects/你的用户名-项目名称/

步骤 3:提交修改

提交信息应遵循以下格式:

# 格式:类型: 简短描述
git commit -m "feat: 添加XXX毕业设计项目"

提交类型规范:

  • feat: 新增功能或项目(毕业设计项目使用此类型)
  • fix: 修复 bug
  • docs: 文档更新
  • style: 代码格式调整(不影响功能)
  • refactor: 代码重构
  • test: 测试相关
  • chore: 其他修改(如依赖更新)

步骤 4:推送到 GitHub

# 推送到你的Fork仓库
git push origin feature/你的项目名称

16.5.2 创建 Pull Request

步骤 1:访问 GitHub

  1. 访问你 Fork 的仓库:https://github.com/你的用户名/hello-agents
  2. 点击"Pull requests"标签,如图 16.3 所示
  3. 点击"New pull request"按钮

图 16.3 创建 Pull Request

步骤 2:选择分支

  • Base repository: datawhalechina/hello-agents
  • Base branch: main
  • Head repository: 你的用户名/hello-agents
  • Compare branch: feature/你的项目名称

步骤 3:填写 PR 信息

⚠️ 重要:PR 标题统一格式

为了便于管理和检索,所有毕业设计项目的 PR 标题必须遵循以下格式:

[毕业设计] 项目名称 - 简短描述

示例:

  • [毕业设计] CodeReviewAgent - 智能代码审查助手
  • [毕业设计] StudyBuddy - AI学习伙伴
  • [毕业设计] DataAnalyst - 智能数据分析师

PR 描述模板:

## 项目信息

- **项目名称**:XXX
- **作者**:@你的用户名
- **项目类型**:生产力工具/学习辅助/创意娱乐/数据分析/生活服务

## 项目简介

简要描述你的项目(2-3句话)

## 核心功能

- [ ] 功能1
- [ ] 功能2
- [ ] 功能3

## 技术亮点

- 使用了XXX范式
- 实现了XXX功能
- 优化了XXX性能

## 演示效果

(可选)添加截图或GIF展示项目效果

## 自检清单

- [ ] 代码能够正常运行
- [ ] README文档完整
- [ ] requirements.txt完整
- [ ] 有清晰的使用示例
- [ ] 代码有适当的注释

## 其他说明

(可选)其他需要说明的内容

步骤 4:提交 PR

如图 16.4 所示,点击"Create pull request"按钮提交。

图 16.4 提交 Pull Request

16.5.3 响应 Review 意见

提交 PR 后,社区成员会 review 你的代码并提出建议。请及时响应:

  1. 查看评论:在 PR 页面查看 reviewer 的评论
  2. 修改代码:根据建议修改代码
  3. 提交更新:
    git add .
    git commit -m "fix: 根据review意见修改XXX"
    git push origin feature/你的项目名称
    
  4. 回复评论:在 GitHub 上回复 reviewer,说明你的修改