文章贡献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时，你的文章就被录入啦！