指引

概述#

我们希望 rk-docs 可以帮助用户清晰快速地了解 RK 启动器以及其他附属产品。

如果您想添加/修改文档中的内容，请您先在创建一个 issue，描述您的提案，讨论此次的修改。

在沟通交流的过程中，请授予 rk-docs 贡献者您的尊重，并且认真对待我们的行为准则。

目前我们没有使用类似 netlify 的服务来自动化部署此文档，所以，在做修改的时候，请遵从传统的 Git 流程。

git clone https://github.com/rookie-ninja/rk-docs.git

rk-docs 使用了 mkdocs-material 来生成文档页面。

因此，如果想要本地调试，我们需要安装如下依赖：

pip install mkdocs-material

mkdocs serve

创建一个新的 branch（请尽量根据功能名字来命名 branch）:

git checkout master
git fetch upstream
git rebase upstream/master
git checkout -b cool_new_feature

您可以随时通过 ($ mkdocs serve) 命令来验证修改。

git push origin cool_new_feature

此时，您正在等待我们审核您的更改。我们尝试回应在几个工作日内提出问题和拉取请求，我们可能会建议一些改进或替代方案。一旦您的更改获得批准，其中项目维护者将合并它们。

如果您符合以下条件，我们更有可能批准您的更改：