查看原文
其他

如何参与共建FISCO BCOS?

FISCO BCOS团队 FISCO BCOS开源社区 2022-06-18

FISCO BCOS是完全开源的金融级联盟链底层技术平台,由金链盟开源工作组通力打造。开源工作组成员包括微众银行、腾讯、四方精创、深证通、华为、亦笔科技、神州信息、博彦科技和越秀金科等金链盟成员机构。


代码仓库:

https://github.com/FISCO-BCOS/FISCO-BCOS  


对平台感兴趣可以star我们。欢迎各路大神一展所长,积极参与建设,为平台添砖加瓦。


FISCO BCOS下属40余个项目,不同项目上手难度各不相同,代码风格、修改规范等也略有差异。如果你想为FISCO BCOS做出贡献,这里有一个简单的列表可供参考:
  • 用的不爽,自己不想改 →提issues
  • 程序可能有bug →提issues
  • 文档没看懂,不知道怎么改 →issues
  • 文档有一些笔误,我想顺手改掉 →通过网页修改文档 
  • 代码有值得优化的地方 →提交pr
  • 我自己基于FISCO BCOS做了新的特性,想贡献到项目中 →提交pr
  • 我很牛,我开发了一个FISCO BCOS的新项目→联系社区人员




提issues


当你在体验/使用过程中遇到问题,需要联系开发者对问题进行确定,或想要反馈优化建议,可以通过该项目的issues界面发起issues。

 

issue可跟踪,可复现。你提出的每一个bug ,都会沉淀下来,为那些和你遇到同样 bug 的人提供帮助。具体提交issue方式可参考以下步骤:


 前期准备 


创建GitHub账号并登录该账号


 操作演示 


打开FISCO BCOS平台的issues界面,此处可参考链接:

https://github.com/FISCO-BCOS/FISCO-BCOS/issues



在title栏中描述问题类别,如:xxx-bug;在comment中详细描述您遇到的问题。如果您是第一次对该项目提issues,可以查看右侧的contributing guidelines。


 提issues Tips 

 

  • 检索问题是否已经存在:高效解决问题,节省大家的时间,我们建议你在发起issues前,先通过官方文档,或issues界面进行搜索,定位是否有和您相同的问题出现过。
  • 清楚描述问题:尽可能地减少沟通成本,我们期望你提交的issue能包含以下内容:使用明确的标题、使用的项目版本、使用的操作系统,出现问题的事实形式,出现问题时程序的log。
  • 解决流程:项目维护人员会根据您提出的问题,给该issues打标签,您可以根据工作人员的回复,在指定路径体验修复该问题后的软件版本。当该issues标记为resolved后,如果您的问题已经解决,可以选择关闭该issues。



通过网页修改文档


查阅FISCO BCOS文档时,如发现有描述错误的地方,你可以通过网页来对文档进行修订。


 前期准备 


创建GitHub账号并登录该账号


 适用场景 


  • 修改已有文档内容

  • 对已有pr进行修改


 操作演示 


  场景1 修改已有文档内容


以修改[使用手册/节点准入]文档为例,对提pr步骤进行说明。

https://fisco-bcos-documentation.readthedocs.io/zh_CN/release-2.0/docs/manual/node_management.html


修改示例如下图所示:你发现文档中输出+++日志部分的描述,替换成输出带有"+++"的日志的描述更准确。



修订操作请看演示:



pr合入后,你会收到电子邮件通知。


  场景2:对已有pr进行修改


1.打开原有pr页面;


2.点击`Files changed`进行页面跳转,再点击铅笔状图标;



3.进行修改;


4.下拉至页面结束处,如选择将本次修改内容提交到原有pr(默认第一项),可直接点击`Commit changes`按钮,修改完成;



5.如选择将本次修改内容新建pr,点击第二项后将跳转页面,参照场景1的步骤继续操作。



提交pr


感谢你能将自己的代码贡献到FISCO BCOS中,更为详细的协作方式,大家可以参考《揭秘FISCO BCOS开源项目开发协作》,这里将介绍基本的pr步骤。


 适用场景 


当你基于FISCO BCOS的某个版本,与开发者沟通后,已经完成基于该版本新特性的开发,或bug修复、自测。


 前期准备 


  • 创建GitHub账号并登录该账号(同上述过程一致)

  • 使用格式化工作,确保代码通过自动化检测


 操作演示 



 FISCO BCOS pr合并流程 


FISCO BCOS的项目中均配置有自己的自动化测试,你的pr提交后,请耐心等待自动化测试完成(半小时之内)。同时,你需要保证所有的单元测试时正确,合入的代码均可以在目前支持的平台上编译、执行成功,且提交的代码满足该项目的风格规范。


pr提交后,请耐心等待项目维护者进行Review。


一般来说,提交的pr会在两个工作日内进行review,项目维护者在review过程中提出一些修改建议,当修改完成后,项目维护者会将该pr标记为approve,你将会在你的GitHub邮箱中收到一封邮件。当收到两个approve后,该pr将会被合并。


一旦pr被合入,你将成为社区贡献者,登上社区贡献者荣誉榜(点击阅读原文查看榜单),并且可获得社区周边专属纪念品。欢迎大家积极参与共建FISCO BCOS。



获得帮助


 加入社群 


我们建有多个FISCO BCOS技术交流群,聚集各路区块链极客,欢迎你加入交流。我们纯聊技术话题,分享硬核干货,探讨基于区块链技术的商业应用场景。加入请添加社区小助手↓↓↓




FISCO BCOS的代码完全开源且免费

下载地址↓↓↓

https://github.com/FISCO-BCOS/FISCO-BCOS


您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存