深入浅出FISCO BCOS¶
介绍¶
新的一年已经开启,为了感谢大家的长久陪伴和倾力支持,我们将FISCO BCOS开源社区成立至今超400篇技术干货和经典篇章整理成文,作为区块链干货合辑,分享给大家! 请点击这里查阅完整版
《深入浅出FISCO BCOS》分为六大章节,由社区全体成员共创完成并不断优化,社区开发者可以在GitHub上提交PR贡献文章,分享FISCO BCOS开发经验与使用心得。
区块链的概念与原理¶
FISCO BCOS的部署运维与实战工具¶
如何参与社区开发协作¶
FISCO BCOS应用实践¶
社区开发实践¶
社区写作指南¶
文章贡献选题¶
基础科普类——分享你对区块链基础概念和原理进行科普和介绍;
开发实操类——分享你的开发、部署、运维等实操经验,包括但不限于踩坑经历和闭坑经验。
应用实践类——如果你对某个场景有深入研究和探索积累,欢迎分享该应用场景下的解决方案与思路。
文章贡献PR操作指引¶
如果你已经是社区贡献者,可直接按照如下操作完成文章PR提交;如果你初次尝试PR贡献,请点击了解提PR基本操作指引。
1、提PR的预置条件:Fork FISCO-BCOS-DOC到个人github仓库¶
step1:进入注册GitHub账号
step2: Fork FISCO-BCOS-DOC 到个人仓库
2、分支说明¶
PR须提到FISCO-BCOS-DOC的dev分支
3、必备工具:git 点击参考¶
mac系统:brew install git
windows系统:点击下载安装
ubuntu系统:sudo apt install git
centos系统:sudo yum install git
4、主要的git命令:¶
(以下步骤只需要执行一次即可)
将官方的FISCO-BCOS-DOC添加为upstream: git remote add upstream
(以下步骤每次都要操作)
每次提交PR之前,均需要执行以下命令,同步最新的官方文档:
拉取官方文档dev分支的最新文档:git fetch upstream dev
同步官方文档dev分支最新文档到本地:git rebase upstream/dev
(注:本步骤可能会有冲突,如果有冲突,请解决冲突,点击参考冲突解决方法)
将同步后的文档推到个人的git仓库:git push origin -f
提交个人文档的主要命令
git add, git commit, git push等,点击参考。
5、文档格式说明¶
须采用markdown的格式编辑文章内容,点击参考markdown语法。
(本步骤不强制) 提交PR之前,建议先基于个人仓库的文档构建readthedocs,检查构建出来的文档显示是否符合预期,并在提交PR的时候,附带说明个人构建的readthedocs链接。
点击参考readthedocs构建方法, FISCO-BCOS-DOC的readthedocs配置选项参考下表:
设置字段 | 设置结果 |
---|---|
默认分支 | release |
文档类型 | Sphinx |
所需的文件 | repuirements.txt |
Python解释器 | CPython |
使用系统包 | 是 |
Python配置文件 | conf.py |
6、Reviewer反馈和合入¶
提交PR后,Reviewer会将修改意见直接在GitHub上进行反馈,你也可以添加小助手微信FISCOBCOS010进行直接沟通;最后当Reviewer合入PR时,你的文章就被录入啦!
文章PR贡献写作规范¶
开头署名为撰稿人姓名,也可以展现个人所属公司或学校,例如,作者:张三 | FISCO BCOS核心开发者;
文章内容尽量包含引言介绍,段与段之间自然衔接和过度,文末总结;
文章应保证文句通顺、无语病,表述不会引起读者误解;
实操类文章需确保技术点准确无误,并能完成测试跑通;
如果文章中涉及到相关技术文档或代码仓库链接,为避免链接失效,请使用FISCO BCOS官方链接。