优化文档
贡献力量#
感谢你考虑为N.I.N.A的文档贡献力量!
预备条件#
本文档使用了MkDocs。有关如何设置它以及如何使用 MkDocs 的详细指南,请参阅其项目主页MkDocs
你需要提前准备好:
- Python
- Pip
pip install --upgrade pip
- MkDocs
pip install mkdocs
- MkDocs Material
pip install mkdocs-material
- 一个你喜欢的Markdown编辑器
编译文档#
MkDocs 内置了一个简单的Web服务器,可动态在本地计算机上生成和预览文档。每次保存文件时,本地服务器都会自动更新。
要运行服务器,只需运行服务命令,并在指示的地址打开浏览器即可。
mkdocs serve
分支规范#
本项目遵循标准的Git工作流,它有如下分支:
- master: 全部官方已正式发布的代码
- hotfix/
: 基于Master分支,做一些问题的修复 - release/
: 当我们准备发布一些新功能时,我们会为其新建一个临时的发布分支 - bugfix/
: 如果在一个发布中发现了bug,我们会新建一个bugfix分支来修复 - develop: 一个通用的开发分支,其中会包含未发布的新功能和特性
- feature/
: 新的功能会在此开发,然后合并到开发分支
Master和Develop是最重要的两个分支。这些分支在首页都有独立的文档页面。
这样,使用N.I.N.A的用户可以根据自己使用的版本找到相应的文档,例如正式版的用户可以看Master分支对应的文档,而使用Nightly-Build版本的用户则可以查看开发分支对应的文档以查阅有关新特性的说明。
向我们提交你的代码#
- 要为本文档贡献一份力量,你可以先Fork一份代码到你的账号下
- 在你的代码仓库中进行修改编辑
- 当你完成了你的修改,就可以通过提交一个Pull Request请求发送给我们,来申请将代码从你的仓库合并到我们的仓库中
- 请确保你的合并申请中只包含相关的修改
- 请检查文档使用使用服务命令正确生成
- 请尽量为每个功能特性创建一个合并申请
- 仅针对开发分支创建新功能的合并申请
更新首页#
主页上的文档会通过Bitbucket提供的服务自动更新。每次合并请求被接受并合并完成后,Bitbucket都会自动生成文档并更新首页。
贡献者完全不必关注这部分内容。