当阅读 CodeFever 文档过程中发现文档中有缺失或错误时, 并且你有能力进行补充或修复时， 欢迎向我们提交文档 PR 。
文档 PR 接收的内容:
- 文档中的错误
- 文档中缺失的描述
- 新增更详细的文档内容
- 翻译工作
满足以上任何一条的 PR 均可以被合并。
提交文档 PR 的步骤如下:
Fork本项目- 在自己的仓库下完成文档编辑工作
- 提交
PR前请到issue中搜索您的修改是否解决了某些issue, 如果解决了, 请在提交PR时引用 - 提交
PR到dev/master分支
在正式贡献文档之前, 建议阅读下一节内容:
文档要求
-
CodeFever文档时树形结构, 以/doc为根目录/doc/zh-cn是中文文档目录/doc/en-us是英文文档目录。 目录按照文档内容区分并分级, 每级目录下的index.md文件为目录文件, 所有文档均为Markdown文档。 -
目录文件每行是一个
Markdown链接, 使用相对路径链接其他文档。 -
文档文件名由
单词和下划线组成; 使用Markdown语法; 图片和附件均保存在文档当前目录的assets目录下, 使用相对路径引用。