文章目录
- 前言
- 一、什么是 Fork 和 PR？
- 1. Fork（分叉）
- 2. PR（Pull Request，拉取请求）
- 二、两种常见的贡献代码方式
- 1. Fork 后通过 PR 提交代码
- 2. 直接在项目分支中修改
- 三、如何 Fork 和发起 Pull Request：详细流程
- 1. Fork 项目
- 2. 将项目 Clone 到本地
- 3. 创建新的功能分支
- 4. 修改并提交推送代码到远程仓库
- 5. 发起 Pull Request
- 6. 等待代码审查并进行修改
- 6. 同步你的 Fork 仓库
- 总结
前言
在开源项目中贡献代码不仅能帮助推动项目的发展，同时也能锻炼自己的技术能力，学习到更多优秀的编程实践。无论你是一个初学者还是有经验的开发者，通过贡献开源代码，你都能在协作中成长。本文将详细介绍如何通过 Fork 和 PR 的方式向开源项目贡献代码，并讲解两种常见的代码贡献方式。
一、什么是 Fork 和 PR？
1. Fork（分叉）
Fork 是 GitHub 等代码托管平台上的一个功能，用来创建某个仓库的完整副本，并将其保存到你的账户中。它的作用是让开发者在原项目基础上自由修改代码，而不会直接影响原项目。
作用：
- 独立的副本：你可以在不影响原项目的情况下，自由修改和实验代码。
- 贡献代码：通过
Fork，可以修改代码并提交Pull Request（PR），向原项目贡献代码。 - 学习和参考：开发者可以
Fork一些有价值的开源项目，学习其代码结构和编程技巧。
使用场景：通常适用于没有原项目写入权限的开发者。
2. PR（Pull Request，拉取请求）
Pull Request（简称 PR） 是向项目维护者提出合并代码的请求。它允许你将修改后的代码提交给原项目，并等待项目维护者审核和决定是否将其合并到项目的主分支中。
作用：
- 代码审查：通过
PR，项目维护者或团队成员可以审查代码的改动，确保其符合项目的质量标准和代码风格。 - 协作开发：团队成员可以通过
PR讨论、建议、修改代码，从而实现更高效的协作。 - 贡献代码：外部开发者可以通过
PR向开源项目贡献代码。
使用场景：PR 是外部贡献者向开源项目提交修改的主要方式，也是团队内部协作开发的重要机制。
二、两种常见的贡献代码方式
在开源项目中贡献代码，常见有两种方式：
1. Fork 后通过 PR 提交代码
这种方式最为常见，适用于没有写入权限的外部开发者。开发者通过 Fork 项目副本、修改代码并提交 PR 来贡献代码。
2. 直接在项目分支中修改
如果你是项目的核心成员或拥有项目的写入权限，则可以直接在项目分支中创建新的功能分支并提交代码。这种方式适合团队成员协作开发，无需额外 Fork，但也需要通过 Pull Request 进行代码审查。
接下来我们将着重介绍第一种方式，即 Fork 后通过 PR 提交代码的详细流程。
三、如何 Fork 和发起 Pull Request：详细流程
1. Fork 项目
首先，找到你想要贡献的开源项目(例如🚪)。在 GitHub 上，进入该项目的页面，点击右上角的 Fork 按钮
Fork复刻之后，你就会在自己的 GitHub 账户下生成一个该项目的副本仓库🚪
2. 将项目 Clone 到本地
Fork 完成后，接下来将副本项目克隆到本地，以便进行代码修改。在你的终端中，使用以下命令克隆项目到本地：
git clone https://github.com/你的用户名/项目名称.git
示例：
git clone https://github.com/huahuahua1223/letsmove.git
克隆后，你的本地项目将与 Fork 的副本保持同步
3. 创建新的功能分支
PS：这步为可选项，也可以直接在副本的主分支上进行修改
为了保持项目的主分支整洁，建议在修改代码之前，先创建一个新的功能分支。使用以下命令创建并切换到新分支：
git checkout -b 新功能分支名
4. 修改并提交推送代码到远程仓库
改动务必遵循项目的代码风格和贡献指南（通常项目仓库的
CONTRIBUTING.md文件中会有详细说明），修改完成后，先将更改提交到本地Git，然后将这些修改推送到远程仓库（Fork 的副本）
首先，检查是否连上远程Git副本仓库，再将修改添加到 Git 暂存区并提交，最后，将你的功能分支推送到 GitHub（此步详细教程请看博客🚪）：
git remote -v
git add .
git commit -m "简要描述你的修改"
git push origin 功能分支名
5. 发起 Pull Request
推送完成后，回到 GitHub 的 Fork 仓库页面，你会看到自己刚才提交推送的代码出现再Fork仓库
点击如图创建一个拉取请求PR：
选择要合并到的开源项目仓库的分支以及合并进去的本地Fork下来的仓库的分支
一般正常情况这里会有“创建拉取请求”按钮（这里我没有‘创建拉取请求’按钮是因为我已经合并进去过了）
在 PR 页面，你需要填写以下信息：
- 标题：简要描述你的修改。
- 描述：详细说明你做了哪些修改、解决了什么问题以及为什么需要这些更改。如果是修复某个
issue，请在描述中引用该issue编号，如fixes #123。
然后，点击 Create pull request，正式发起 PR
6. 等待代码审查并进行修改
提交 PR 后，项目的维护者或核心开发者会对你的代码进行审查。他们可能会给出反馈，要求你进一步修改或优化代码。你需要及时响应，并根据反馈进行修改。
如果需要修改，你可以在本地继续修改代码并推送到同一个功能分支，这些更改会自动同步到你之前的 PR。
当 PR 通过审查并被项目维护者接受后，他们会将你的修改合并到主分支中。这时，你的贡献就正式成为了该项目的一部分！！！
6. 同步你的 Fork 仓库
在项目持续开发过程中，原始项目可能会有新的改动。为了保持你的 Fork 项目与原项目同步，你需要定期从原项目拉取更新。具体操作如下：
首先，添加原项目的远程仓库地址：
git remote add upstream https://github.com/原项目/项目名.git
然后，拉取原项目的最新更新并合并到你的 Fork：
git fetch upstream
git merge upstream/main
这样就能保证你的 Fork 项目是最新的
总结
通过本文，我们详细介绍了如何通过 Fork 和 Pull Request （PR） 方式向开源项目贡献代码，并提供了完整的操作流程。从 Fork 仓库、克隆到本地、创建功能分支、提交代码到发起 PR，再到同步原项目的步骤，逐步讲解了每个环节的操作方法与注意事项。希望这篇文章能帮助你在开源社区中顺利贡献代码并提升协作开发的能力。如果有任何问题或想法，欢迎在评论区交流探讨！🌹
