中文站

手把手教你如何成为开源贡献者

01:Fork 项目:GameSentry


打开我们的开源项目链接,在右上角有一个 Fork 按钮,点击 Fork 就能将项目克隆到我们个人的 github 账号(假设取名 developer-note),这时我们就可以在个人账号的 Repositories 找到这个 developer-note 项目,我们拥有全部修改权限,且任何操作对原开源项目没有影响,可以自由改动。 

02:拉到本地,关联开源项目


03:创建分支,开发贡献

通常我们建议每次贡献都创建新的开发分支,例如:dev-20221024,名字可以自由命名,比如参考原有项目开发分支命名或根据本次贡献时间/内容命名。


然后就是开始自己对项目的修订,可以是增加功能,项目调优,修订 bug 等,不限内容,只要是你觉得能让开源项目变的更好的内容都可以自由发挥。 

04:pull request (PR)

当完成某个开发分支的工作后,下一步便是将这个新的版本 PR (Pull request) 更新提交给开源作者。Github 会提醒开源作者我们做了这个更新,如果 review 没问题,开源作者团队 lgtm 那么就会将对应的分支合并到开源项目中:

01

在 github 的 developer-note 项目中,可以看到 issue 旁边有个 Pull request,点击进去新建 Pull request;

02

在分支选项中选择需要提交的分支,选中后检查内容的变更,然后可以 Create pull request 创建 PR;

03

成功后在开源项目的官方列表中能看到 Pull request 记录,开源作者会检查 (review) 我们贡献的内容;

04

如果开源作者团队觉得 lgtm(looks good to me)就会将新的分支合并到开源项目中;具体来说就是开源作者会点击 Merge Pull request 选项,根据需要选择合适的合并方式:

· 将所有提交合并到基础分支

通过点击 Merge pull request。如果没有展示 Merge pull request 选项,则点击合并下拉菜单,然后选择 Create a merge commit

· 压缩合并 Pull request 的提交

通过合并下拉菜单,选择 Squash and merge,然后点击 Squash and merge 按钮

· 将提交单独变基到基础分支上

通过合并下拉菜单,选择 Rebase and merge,然后点击 Rebase and merge 按钮。

· 如果出现冲突问题,一般通过安装 git 解决冲突流程就能解决;

· 如果发现存在 bug,可以直接在 Pull request 中直接进行讨论,然后贡献者根据讨论的解决方案提交一个新的提交,操作流程参考前述流程;

05:完成合并,删除分支

1.如果开源作者 review 贡献者贡献的内容没有问题,就可以提交到 master 分支;

2.提交完贡献者可以通过分支查看开源作者是否已将更新成功过合并;

3.完成合并后贡献者可以关闭当前的 pull request 并删除该分支,开源贡献者直接 pull 开源项目的最新代码就能查看到我们贡献的代码。


我们能发现,成为贡献者的步骤很简单,几乎没有任何限制,任何人都可以成为开源贡献者,对开源作者来说也没有任何负面影响。众人拾柴火焰高,希望各位对游戏有热爱的开发者们都能参与到我们的开源贡献中来!

点击进入 Github 开源地址