如何参与纸壳CMS开发以及贡献代码

如何参与纸壳CMS开发以及贡献代码

ZKEASOFT November 07, 2018


纸壳CMS是基于GPL v3.0开源协议开源的自由软件,可以免费使用它来做任何开源项目。同时也可以提交您的代码到官方仓库,让您的修改不被覆盖。比如你修改了一个已知的BUG,就可以将你的修改提交给主仓库,这样你的修改就会被保留下来。要参与纸壳CMS的开发很简单,只需要有一个GitHub的账号就可以了。

仓库地址

GitHub:https://github.com/SeriaWei/ZKEACMS.Core

Fork

做的第一件事情就是“Fork”。简单的说,就是在你自己的账户下,克隆一个一模一样的仓库。为什么要Fork?因为别人账户下的仓库,你没有权限进行提交代码,但自己仓库下的可以,所以要先加纸壳CMS Fork到自己的账号下。Fork的方式很简单,直接点击右上角的"Fork“即可。

这样,在你自己的GitHub账号下就多了一个纸壳CMS的仓库

Clone

接下来要做的事情就是把仓库代码Clone到本地。注意这里克隆的是你自己账户下的纸壳CMS项目,而不是官方的项目地址。如:

git clone https://github.com/Timynore/ZKEACMS.Core.git

如果你不知道如何用git clone下载项目代码,可以参考这篇文章:https://www.zkea.net/codesnippet/detail/post-50.html

克隆的时间长短与个人的网速有关,请耐心等待。

Coding

代码克隆下来以后就可以开始开发了,开发相关可以先查看相关文档。https://www.zkea.net/zkeacms/document

开发的时候,您可以选择创建新的分支,这样可以与主分支分开。用单独分支开发是推荐的做法。

Commit

在代码修改完成以后,就要提交代码了。先将您的代码提交到本地仓库,并在提交的时候做一些简单的说明。

鼠标右键,选择Commit:

输入这次修改的说明,并点击提交(Commit)。

这样,刚修改的代码就提交到了本地仓库。接下来需要把代码同步到远端仓库GitHub上。可以在刚才提交完成以后,直接点击Push:

或者鼠标右键>TortoiseGit>Push:

然后直接点击确定,等待代码推送完成。

推送完成时显示如下:

这样,刚修改的代码就已经提交到了GitHub上了。

Pull Request

在代码提交到GitHub以后,就可以发起来个Pull Request(拉取请求)。意思就是请求纸壳CMS主仓库拉取你仓库的代码进行合并。点击GitHub上项目主界面上的”New pull request“:

注意选择将代码合并到开发分支(develop)

最后,点击”Create pull request“:

输入简单说明,再次点击”Create pull request“就可以了:

你的代码并不会马上就合并到纸壳CMS的分支中,需要等待作者的查阅后才会被合并。

Synchronization

在Fork了代码仓库一段时间后,你账号里的仓库可能就不是最新的了。可以通过发起拉取请求同步最新代码。GitHub会告诉你当前分支的差异信息,然后点击拉取请求即可。

这里要注意,GitHub上的显示是把右边的代码合并到左边,所以要把自己的仓库转到左边如果不是在左边的话。

右边选择纸壳CMS官方仓库:

然后点击”Create pull request“,再合并即可:

点击确认合并,就可以将代码合并过来了:


微信公众号