如何参与贡献开源项目的代码
如何参与贡献开源项目的代码
这里以github上的操作为例
假设下图就是要贡献代码的开源仓库
步骤
- 第一步就是需要先fork开源项目
在要贡献代码的仓库页面点击
fork
按钮fork
完成后就可以在自己的仓库中看到这个 仓库 - 克隆仓库
下一步就是我们需要将
fork
的仓库克隆到自己的本地电脑上,下面假设你已经安装好了git工具
。
首先我们在github
页面上复制我们刚才fork
后的仓库的地址:
找一个合适的位置,打开命令行,输入以下命令
|
|
之后切换到克隆下来的仓库目录下
- 准备工作
添加上游仓库:使用以下命令将原始项目(就是你要要贡献代码的仓库)仓库作为上游仓库添加到本地仓库:
|
|
查看远程仓库列表: 在上游仓库发生更改变化的时候,本地可能需要拉取同步更新,使用以下命令拉取上游仓库的更改,并将其合并到您的本地分支中(由于刚从上游仓库克隆下来所以并没有什么更改):
|
|
上面的命令也可以合为:
|
|
下面是我执行的操作:
创建开发分支:分支是你的更新的副本。使用分支,您可以在不影响主分支的情况下,对代码进行更改。使用以下命令在本地创建一个新分支并切换到该分支上:
|
|
我这里创建并切换到了dev
分支(名字你可以随便起,不过可以写和这个分支要做的事情相关的描述或许更好):
- 进行代码贡献
在本地计算机上进行所需的更改。确保您的更改符合项目的贡献指南,并且经过了充分的测试和代码审查。
这里我作为测试对README.md
进行修改,添加一段语句如下:
- 添加更改
使用以下命令将更改添加到暂存区中:
|
|
其中 <file_name> 是您想要添加的文件名称。如果想要添加所有更改,可以使用以下命令:
|
|
下面是我执行的操作:
- 提交更改
使用以下命令将更改提交到本地分支中:
|
|
其中 “Commit message” 是对更改的简短描述,可以根据对应的项目贡献指南按规范来描述你的更改。
下面是我执行的操作:
查看提交记录:
- 推送更改
使用以下命令将更改推送到您的远程分支中:
|
|
其中 <branch_name> 是您创建的分支名称。
下面是我执行的操作:
- 创建拉取请求
在你Fork的项目仓库页面上,点击
Pull requests
,接着单击“New pull request”按钮。选择你刚才的开发分支,添加说明和描述,然后提交拉取请求。
下面是我执行的操作:
选择刚才的开发分支
可以看到我们更改,我们点击绿色按钮Create pull request
之后可以填写标题和修改的内容的描述
填写完成后,点击绿色按钮Create pull request
创建拉取请求。
- 等待审核
等待项目维护者审核您的拉取请求。他们可能会要求您进行更改或修复某些问题。
- 合并更改
如果您的更改被接受,项目维护者将合并您的分支到主分支中。合并后,你会收到一封电子邮件通知。
- 删除开发分支
在代码合并之后,你就可以在本地和远程仓库删除这个开发分支了
|
|