「非常有用」如何正确地给开源项目提交pr?

Posted 鱼头的Web海洋

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了「非常有用」如何正确地给开源项目提交pr?相关的知识,希望对你有一定的参考价值。

如何去参与一个开源库的开发

我们经常看到一个开源库会有很多人一起去维护,像 vue,webpack 就会有很多大牛去维护。

看着这么多大牛去维护一个开源库,心里也直挠痒痒,很想自己也能一起去维护开源库。

很多人在平时开发中只是用到简单的 git 命令,比如 git clonegit branchgit checkout-bgit addgit commitgit push 这些命令,其实都只是 git 最基本的操作,有这些基本操作,我们想给开源库提 pr 还差一点。

下面我把我自己平时维护 git 库的经验做一个总结,也算是给一些想给开源库提 pr 同学的一些微小的帮助。

如果有更好的方法,可以评论补充一下,谢谢大家。

具体流程

想给开源库提 pr,第一步肯定是我们要有他们库,并且可以进行开发。接下来我就拿 vue 库做一个示例,看官们可以边看边和我一起操作。

1. fork 开源库

vue 库肯定不可能让我们直接提交,所以我们需要找到 vue 库,fork 到自己的 github 仓库中,然后在自己拷贝的 vue 仓库中操作。

登录 github,在 github 中搜索 vue。

点击 fork 按钮,把开源库 fork 到自己的 github 中。「非常有用」如何正确地给开源项目提交pr?

回到我们自己的 github 中,就可以看到 fork 好的 vue 库了。「非常有用」如何正确地给开源项目提交pr?

2. clone 库到自己本地

我们将 fork 好的仓库克隆到自己本地电脑上,然后进行开发。「非常有用」如何正确地给开源项目提交pr?

克隆到本地:

 
   
   
 
  1. # 克隆 vue

  2. git clone https://github.com/Shiyanping/vue.git


  3. # 进入本地 vue 文件夹

  4. cd vue

这样你本地就有了 vue 的克隆版本了,后续就可以愉快的开发了。

3. 本地创建分支,进行开发

摩拳擦掌,开始吧,开发之前你要确定好具体开发哪个分支,因为我们拉下来的代码只有默认分支,但是有些开源库是有很多分支的,不同的功能或者不同的版本在不一样的分支上,这个在开发之前要确定好。

如果你只是开发默认分支,可以忽略下面的 开辟我们本地分支 过程,但是开发开源库,肯定避免不了切换不同的分支,还是建议跟着下面的操作执行一下。

开辟我们本地分支:

假设要开发 vue 库中的 weex 分支,这个时候需要借助 origin/weex 分支去开辟一个本地的新分支。origin/weex 就是自己 github 上的 vue 仓库中 weex 分支。

 
   
   
 
  1. # 查看具体有哪些分支

  2. git branch -r

  3. # 这个时候会将我们本地分支,自己 github 仓库分支都列出来。

  4. # 这里就不截图了,我们找到 origin/weex 分支,切换过去。


  5. git checkout origin/weex

  6. # 这里不用管 git 提示,我们只是借助一下这个分支


  7. # 接下来我们使用 origin/weex 分支,开辟一个我们本地的新分支

  8. git checkout -b weex

「非常有用」如何正确地给开源项目提交pr?

这个时候就有了本地的 weex 分支,来改动点东西,执行一下最熟悉的 git 提交代码的过程。

一顿操作之后(其实我只是简单改了说明文档,

以上是关于「非常有用」如何正确地给开源项目提交pr?的主要内容,如果未能解决你的问题,请参考以下文章

如何参与开源项目

参与Github jdk8u开源,提交一个PR

参与Github jdk8u开源,提交一个PR

如何从0开始参与一个开源项目?

如何从0开始参与一个开源项目?

如何从0开始参与一个开源项目?