From 392def7936396955d981325d7b39f13d70a5cf92 Mon Sep 17 00:00:00 2001 From: jigsaw Date: Fri, 28 Jan 2022 13:14:59 +0800 Subject: [PATCH] :memo: Update CONTRIBUTING Co-authored-by: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> --- CONTRIBUTING.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3ab6a0b..3b668832 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,16 @@ NoneBot2 的文档使用 docusaurus，它有一些 [Markdown 特性](https://doc NoneBot2 文档并没有具体的行文风格规范，但我们建议你尽量写得简单易懂。 -如果你需要在本地预览修改后的文档，可以使用 yarn 或 npm 等 Nodejs 的依赖管理工具安装文档依赖后自行部署。 +NoneBot2 的文档使用 [docusaurus](https://docusaurus.io/)，它有一些 [Markdown 特性](https://docusaurus.io/zh-CN/docs/markdown-features) 可能会帮助到你。 + +NoneBot2 文档并没有具体的行文风格规范，但我们建议你尽量写得简单易懂。 + +如果你需要在本地预览修改后的文档，可以使用 yarn 安装文档依赖后启动 dev server，如下所示： + +```sh +yarn install +yarn start +``` ### 参与开发 @@ -51,7 +60,7 @@ NoneBot2 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/ ## 为社区做贡献 -你可以在 NoneBot 商店上架自己的适配器、插件、机器人，具体步骤可参考 [发布插件](https://v2.nonebot.dev/docs/next/advanced/publish-plugin) 一节。 +你可以在 NoneBot 商店上架自己的适配器、插件、机器人，具体步骤可参考 [发布插件](https://v2.nonebot.dev/docs/advanced/publish-plugin) 一节。 我们仅对插件的兼容性进行简单测试，并会在下一个版本发布前对与该版本不兼容的插件作出处理。