知用网
白蓝主题五 · 清爽阅读
首页  > 软件安装

手把手教你提交开源项目的 Pull Request

从零开始参与ref="/tag/65/" style="color:#8B0506;font-weight:bold;">开源:PR 其实没那么难

很多人觉得开源项目高不可攀,代码动不动就几万行,Contributor 清一色是技术大牛。其实不是这样。你用的某个工具少了个小功能,或者文档写得不够清楚,改完提交一个 Pull Request(简称 PR),你就已经是开源贡献者了。

第一步:找到你想参与的项目

打开 GitHub,搜索你平时用的工具,比如 vscodeoh-my-zsh 或者某个你喜欢的命令行小工具。点进项目主页,先看看 README 写了什么,有没有 CONTRIBUTING.md 这种贡献指南。

新手建议从带 good first issue 标签的问题入手。这类问题通常不复杂,维护者也愿意指导新人。

第二步:Fork 项目到自己的账号

在项目页面右上角点 Fork,把整个仓库复制一份到你的 GitHub 账号下。比如原项目是 someone/tool,Fork 后你会得到 yourname/tool

第三步:把代码克隆到本地

打开终端,运行:

git clone https://github.com/yourname/tool.git

进入项目目录:

cd tool

然后添加上游仓库,方便后续同步更新:

git remote add upstream https://github.com/someone/tool.git

第四步:创建新分支

不要直接在 main 分支改代码。新建一个专门的分支,比如修复拼写错误可以叫 fix-typo

git checkout -b fix-typo

这时候你可以用编辑器修改文件了。比如发现 README 里有个单词拼错了,改完保存就行。

第五步:提交你的修改

改完后,把变更加入暂存区:

git add .

然后提交:

git commit -m "修复 README 中的拼写错误"

提交信息尽量写清楚你干了啥,别只写“update file”这种。

第六步:推送到你的仓库

把本地分支推到你 Fork 的远程仓库:

git push origin fix-typo

第七步:发起 Pull Request

打开你 Fork 的项目页面,比如 https://github.com/yourname/tool,会看到一行提示:“Your recently pushed branches”,后面有你刚推的 fix-typo 分支,旁边有个绿色按钮 “Compare & pull request”。

点进去后,GitHub 会显示你改了哪些内容。填上标题和描述,比如:

  • 标题:修复 README 拼写错误
  • 描述:将 "recieve" 改为 "receive",该词出现在安装说明部分。

确认无误后,点 “Create pull request”。

等回复,必要时更新 PR

项目维护者可能会 review 你的代码,提出修改意见。你不需要关闭 PR 重来,只要继续在原来的分支提交改动:

git add .
 git commit -m "根据 review 修改措辞"
 git push origin fix-typo

你会发现,PR 会自动更新,不需要重新提交。

合并成功,恭喜你成为贡献者

一旦你的 PR 被合并,你就正式成为了这个开源项目的贡献者。打开项目的 Contributors 页面,很可能看到你的头像出现了。

下次你朋友说“这软件文档真难懂”,你可以回一句:“我上次就提了个 PR 改了那里,还挺简单的。”