日常妙招屋
白蓝主题五 · 清爽阅读
首页  > 无线组网

开源项目如何提交PR:手把手教你参与代码贡献(实战经验分享)

你在刷 GitHub 的时候,看到一个无线组网相关的ref="/tag/65/" style="color:#643D3D;font-weight:bold;">开源项目,发现有个小功能可以优化,或者文档写得不够清楚。你想改一改,顺便把自己的名字留在贡献者名单里?其实,提交 PR(Pull Request)没那么神秘,就像给朋友发个修改建议,只不过用的是代码

先 Fork 一份到自己名下

打开项目主页,比如是一个叫 wifi-mesh-tool 的工具库。右上角有个“Fork”按钮,点一下,GitHub 就会给你账号下建一个副本。这就像你从图书馆借了本书,在上面做批注,而不是直接在馆藏书上乱画。

把代码下载到本地

打开你的电脑终端,执行:

git clone https://github.com/你的用户名/wifi-mesh-tool.git

进到项目目录:

cd wifi-mesh-tool

创建新分支,别动主干

别直接在 mainmaster 分支上改。新建一个专门的分支,比如你准备修一个热点配置的 bug:

git checkout -b fix-hotspot-config

这样改动隔离,万一出问题也不会影响主线。

动手修改,保存变更

用你喜欢的编辑器打开文件。比如你发现 config.js 里默认端口写错了,改成正确的:

const DEFAULT_PORT = 8081;

改完保存。然后让 Git 记录这些改动:

git add config.js

提交时写清楚你做了啥:

git commit -m "修复热点配置中的默认端口错误"

推送到自己的仓库

把本地的分支上传到你 Fork 的那个 GitHub 仓库:

git push origin fix-hotspot-config

等一会儿,刷新页面,GitHub 会自动提示你“想要提交 Pull Request?”。

发起 Pull Request

点“Compare & pull request”,填写标题和描述。标题要具体,比如“修复热点默认端口为 8081”。描述里可以说清楚为什么改、怎么测试的。如果项目有模板,照着填就行。

等待反馈,可能需要再修改

维护者看到你的 PR 后,可能会评论,比如让你加个日志输出,或者调整格式。你直接在本地分支继续改,再 git push 就行,PR 会自动更新。

合并成功,你就上榜了

一旦你的改动被合并进原项目,你就正式成为贡献者。下次别人用这个工具,说不定就在感谢名单里看到你的名字。这种感觉,就像你在小区群里分享了个路由器桥接妙招,结果被物业采纳了,挺实在的成就感。