参与 FastAdmin 开源贡献的详细流程
FastAdmin 是一款开源的后台框架,致力于服务开发者,为开发者节省更多的时间,目前 FastAdmin 已经有 71 位小伙伴参与了代码贡献。
本篇主要聊聊关于为 FastAdmin 贡献代码的方式,本篇不是一个标准规范,只是提供一个比较容易的可行的参与方式,如有更好的方式也欢迎小伙伴们提出。
关于如何更方便的让小伙伴们参与开源社区,我们也是在不断的探索,现阶段我们总结了大概的流程,如下:
Fork 仓库
-> 修改代码
-> 合并请求
-> 确认合并
开源贡献其实很简单,总共就四步而已,下面针对这四个步骤写一些详细说明。
1. Fork 仓库
1.1. Fork 仓库
找到 FastAdmin 仓库 https://gitee.com/karson/fastadmin
(或者使用 github 仓库也可以),点击 Fork
按键,这时会在自己帐户时建立一个 FastAdmin 仓库复本。
1.2. Clone 到本地
将这 Fork 后的仓库 Clone 到本地,使用命令 git clone https://gitee.com/xxxxxxxx/fastadmin.git
xxxxxxxx 为你的平台标识。
当 clone 到本地后将分支切换到 develop
分支,FastAdmin 开发使用 develop
分支。
切换到 develop 分支后可以开始安装 FastAdmin 的前后端组件,并安装好 FastAdmin。
2. 修改代码
2.1. 创建贡献分支
当把自己仓库里的 FastAdmin 通过 git clone 到本地后,并切换到 develop 分支后,你是不是可以开始贡献代码了呢?
错!这时候你还需要创建一个新的分支,这个分支是基于 develop 分支的,也就是说当你切换到 develop 分支后才去创建一个新的分支,这个分支可以叫修复分支,或者叫新功能分支,在 git 中提倡开新分支,早开分支早轻松。
2.2. 修改分支代码
基于 develop 分支创建的新分支后,就可以开始贡献代码了,提交代码并详细描述。
2.3. 测试贡献代码
对贡献的代码进行测试。
3. 合并请求
当代码贡献完毕,并测试成功,这时就可以将新分支推送到自己的远程仓库,因为你的远程仓库和 FastAdmin 团队仓库有关联,所以推送完成后 码云
会有提交合并提示。
合并请求也可以根据页面上的提示,也可以到 原仓库地址 点击 Pull Request
写上详细的详细的合并请求提交。
当开源贡献者的代码被合并后,开源贡献流程还不算完全结束,你还需要跟进一下代码的合并请求进度和团队沟通贡献代码的细节,以达到合并成功的目的。
4. 确认合并
FastAdmin 团队收到合并请求后会对代码进行检查和测试,或联系开源贡献者沟通,最终根据实际情况进行合并。
5. 后续
其实在合并请求发出后开源贡献者就可以将分支切换回 develop 分支,如果还有新代码需要贡献可以从 2.1 节开始,再创建一个分支,可以继续贡献代码,而新开的分支不会和原先提交的分支冲突,做到并行代码贡献。
好了,到这里整个代码贡献流程结束,如果有疑问可以提出,我知道的会一一解答,并继续完善本篇文章,最后感谢小伙伴们对 FastAdmin 支持,我们我们会更加努力的做好开源,为开发者们节省更多的时间。