Git Fork & PR 教程

Git Fork 与 Pull Request

掌握开源项目协作的核心工作流程，为开源社区贡献力量

开始学习

核心概念

原始仓库

upstream/origin

官方项目仓库
Fork仓库

origin

你的个人副本
本地仓库

local

你的开发环境

什么是 Fork？

Fork是创建仓库的个人副本的过程。当你Fork一个仓库时，GitHub/GitLab会在你的账户下创建该仓库的完整副本。

  • 创建项目的个人副本
  • 独立于原始仓库开发
  • 可以自由实验而不影响原项目
  • 是贡献开源项目的起点

什么是 Pull Request？

Pull Request（PR）是向项目维护者提出更改请求的机制。它允许你通知他人你已推送到仓库的更改。

  • 请求将你的更改合并到原始仓库
  • 促进代码审查和讨论
  • 是开源协作的核心机制
  • 也称为 Merge Request（GitLab）

Fork工作流的优势

  • 权限控制：维护者完全控制代码库
  • 安全协作：贡献者无法直接修改原始仓库
  • 并行开发：多个贡献者可以同时工作
  • 代码审查：所有更改都经过审查流程
  • 学习机会：初学者可以安全地参与项目

注意： Fork与Clone不同。Clone是创建仓库的本地副本，而Fork是创建服务器端的个人副本。通常先Fork再Clone到本地。

Fork & PR 工作流程

1. Fork 仓库

创建原始仓库的个人副本

2. Clone 到本地

将Fork的仓库克隆到本地

3. 创建功能分支

在新分支上开发功能

4. 推送更改

将更改推送到Fork仓库

5. 创建 PR

提出合并到原始仓库的请求

6. 审查与合并

维护者审查并合并PR

详细工作流程

  1. Fork仓库：在GitHub/GitLab上点击Fork按钮
  2. 克隆仓库：git clone https://github.com/yourname/repository.git
  3. 添加上游仓库：git remote add upstream https://github.com/original/repository.git
  4. 创建功能分支：git checkout -b feature/new-feature
  5. 进行更改并提交：git add . && git commit -m "描述"
  6. 推送到Fork仓库：git push origin feature/new-feature
  7. 创建Pull Request：在GitHub/GitLab界面上操作
  8. 响应审查反馈：根据需要更新PR
  9. 同步上游更改：定期更新你的Fork仓库

远程仓库配置

正确配置远程仓库是Fork工作流的关键：

# 查看远程仓库配置
git remote -v

# 典型配置：
# origin https://github.com/yourname/repo.git (fetch)
# origin https://github.com/yourname/repo.git (push)
# upstream https://github.com/original/repo.git (fetch)
# upstream https://github.com/original/repo.git (push)

提示： 使用origin指向你的Fork仓库，upstream指向原始仓库。这样可以轻松地从原始仓库获取更新，同时将更改推送到你的Fork仓库。

核心操作命令

初始设置

  • git clone https://github.com/yourname/repo.git

    克隆Fork的仓库到本地

  • git remote add upstream https://github.com/original/repo.git

    添加上游仓库引用

  • git remote -v

    验证远程仓库配置

  • git fetch upstream

    从上游仓库获取更新

开发流程

  • git checkout -b feature/name

    创建功能分支

  • git add .

    添加更改到暂存区

  • git commit -m "描述"

    提交更改

  • git push origin feature/name

    推送到Fork仓库

同步更新

  • git fetch upstream

    获取上游仓库最新更改

  • git checkout main

    切换到主分支

  • git merge upstream/main

    合并上游更改到本地

  • git push origin main

    更新Fork仓库的主分支

高级操作

  • git rebase upstream/main

    将功能分支变基到上游主分支

  • git push -f origin feature/name

    强制推送（变基后）

  • git cherry-pick <commit-hash>

    选择特定提交应用到当前分支

  • git log --oneline --graph

    查看图形化提交历史

重要： 在推送更改到功能分支后，需要在GitHub/GitLab界面上创建Pull Request。Git命令行本身不提供创建PR的功能。

平台操作指南

GitHub 操作指南
创建 Fork
  1. 导航到要贡献的仓库
  2. 点击右上角的 "Fork" 按钮
  3. 选择你的个人账户作为目标
创建 Pull Request
  1. 导航到你的Fork仓库
  2. 点击 "Pull requests" 标签
  3. 点击 "New pull request" 按钮
  4. 选择基础仓库和目标分支
  5. 填写PR标题和描述
  6. 点击 "Create pull request"
代码审查 CI/CD集成 讨论线程 建议更改
GitLab 操作指南
创建 Fork
  1. 导航到要贡献的项目
  2. 点击右侧的 "Fork" 按钮
  3. 选择命名空间和项目名称
  4. 点击 "Fork project"
创建 Merge Request
  1. 导航到你的Fork项目
  2. 点击侧边栏的 "Merge Requests"
  3. 点击 "New merge request"
  4. 选择源分支和目标分支
  5. 填写MR标题和描述
  6. 点击 "Create merge request"
流水线集成 代码质量检查 议题链接 批准规则

PR/MR 描述模板

一个好的PR描述应该包含：

## 描述
[简要描述这个PR的目的和更改内容]

## 相关议题
Fixes #123

## 更改类型
- [ ] Bug修复
- [x] 新功能
- [ ] 代码重构
- [ ] 文档更新

## 检查清单
- [ ] 我的代码遵循项目风格指南
- [ ] 我进行了自测
- [ ] 我添加了必要的测试
- [ ] 我更新了相关文档

代码审查要点

  • 代码质量：代码是否清晰、可读？
  • 功能正确性：更改是否按预期工作？
  • 测试覆盖：是否包含适当的测试？
  • 文档更新：是否需要更新相关文档？
  • 性能影响：更改是否影响性能？
  • 安全性：是否存在安全风险？

审查技巧： 提供具体的、可操作的反馈。使用"建议"而不是"必须"的语气。感谢贡献者的努力。

最佳实践

贡献者最佳实践

准备工作
  • 阅读项目的贡献指南
  • 检查现有议题和PR，避免重复工作
  • 在开始编码前讨论你的方法
  • 确保你的开发环境设置正确
开发过程
  • 保持提交小而专注
  • 编写清晰的提交信息
  • 遵循项目的代码风格
  • 添加或更新相关测试
  • 更新文档以反映更改
PR 提交
  • 填写完整的PR描述
  • 链接相关议题
  • 确保CI/CD流水线通过
  • 及时响应审查反馈
  • 保持礼貌和专业

维护者最佳实践

项目管理
  • 提供清晰的贡献指南
  • 标记适合新手的议题
  • 设置明确的代码审查标准
  • 使用模板和检查清单
沟通与反馈
  • 及时响应PR和问题
  • 提供具体、建设性的反馈
  • 感谢贡献者的努力
  • 解释拒绝PR的原因
  • 鼓励和指导新贡献者
技术管理
  • 设置分支保护规则
  • 配置CI/CD流水线
  • 使用代码质量工具
  • 定期同步Fork的仓库
  • 清理已合并的分支

常见问题与解决

  1. 从上游获取最新更改：git fetch upstream
  2. 合并或变基到你的分支
  3. 手动解决冲突文件中的冲突标记
  4. 添加已解决的文件：git add .
  5. 完成合并：git commit
  6. 推送更新：git push origin feature/branch

  1. 确保已添加上游仓库：git remote add upstream URL
  2. 获取上游更改：git fetch upstream
  3. 切换到主分支：git checkout main
  4. 合并上游更改：git merge upstream/main
  5. 推送到你的Fork：git push origin main

  • 仔细阅读审查反馈
  • 询问澄清不理解的意见
  • 根据反馈进行必要的更改
  • 推送更新到同一分支
  • PR会自动更新，无需创建新的
  • 保持积极和专业的态度

完整工作流示例

# 1. Fork仓库（在GitHub/GitLab界面操作）

# 2. 克隆你的Fork
git clone https://github.com/yourname/project.git
cd project

# 3. 添加上游仓库
git remote add upstream https://github.com/original/project.git

# 4. 创建功能分支
git checkout -b feature/awesome-feature

# 5. 进行更改并提交
# ... 编辑文件 ...
git add .
git commit -m "实现新功能"

# 6. 推送到你的Fork
git push origin feature/awesome-feature

# 7. 创建Pull Request（在GitHub界面操作）

# 8. 响应审查反馈
# ... 根据反馈进行更改 ...
git add .
git commit -m "根据审查反馈更新"
git push origin feature/awesome-feature

# 9. PR合并后清理
git checkout main
git branch -d feature/awesome-feature
git fetch upstream
git merge upstream/main
git push origin main
上一章: Git 推送与拉取 下一章: Git 储藏更改