From 2924c74333afab0d7a3b793ab42312abe45b755a Mon Sep 17 00:00:00 2001 From: jigsaw Date: Wed, 26 Jan 2022 20:34:56 +0800 Subject: [PATCH 1/4] :memo: Add CONTRIBUTING --- CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 6 +---- 2 files changed, 67 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9d2874f1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# NoneBot2 贡献指南 + +首先，感谢你愿意为 NoneBot2 贡献自己的一份力量！ + +本指南旨在引导你更规范地向 NoneBot2 提交贡献，请务必认真阅读。 + +## 提交 Issue + +在提交 Issue 前，我们建议你先查看 [FAQ](https://github.com/nonebot/discussions/discussions/13) 与 [已有的 Issues](https://github.com/nonebot/nonebot2/issues)，以防重复提交。 + +### 报告问题、故障与漏洞 + +NoneBot2 仍然是一个不够稳定的开发中项目，如果你在使用过程中发现问题并确信是由 NoneBot2 引起的，欢迎提交 Issue。 + +### 建议功能 + +NoneBot2 还未进入正式版，欢迎在 Issue 中提议要加入哪些新功能。 + +为了让其他开发者们更好地理解你的意图, 请认真填写预期行为等内容, 如果可能, 可以提出可行的解决方案猜想 + +## Pull Request + +### Commit 提交规范 + +NoneBot 的 commit message 格式遵循 [gitmoji](https://gitmoji.dev/) 规范，在创建 commit 时请牢记这一点。 + +NoneBot 使用 [Poetry](https://python-poetry.org/) 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。 + +下面的命令能在已安装 Poetry 和 npm 的情况下帮你快速配置开发环境。 + +```sh +poetry install +precommit install +npm -g i gitmoji-cli +gitmoji -i +``` + +请确保你的每一条 commit 都有清晰的描述它做了什么, 一个 commit 尽量只做一件事情。 + +### 撰写文档 + +NoneBot2 的文档使用 docusaurus，它有一些 [Markdown 特性](https://docusaurus.io/zh-CN/docs/markdown-features) 可能会帮助到你。 + +NoneBot2 文档并没有具体的行文风格规范，但我们建议你尽量写得简单易懂。 + +如果你需要在本地预览修改后的文档，可以使用 yarn 或 npm 等 Nodejs 的依赖管理工具安装文档依赖后自行部署。 + +### 参与开发 + +NoneBot2 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/) 与 [PEP 484](https://www.python.org/dev/peps/pep-0484/) 规范，请确保你的代码风格和项目已有的代码保持一致，变量命名清晰，有适当的注释与测试代码。 + +## 为社区做贡献 + +你可以在 NoneBot 商店上架自己的适配器、插件、机器人，具体步骤可参考 [发布插件](https://v2.nonebot.dev/docs/next/advanced/publish-plugin) 一节。 + +我们仅对插件的兼容性进行简单测试，并会在下一个版本发布前对与该版本不兼容的插件作出处理。 + +虽然对插件的内容没有严格限制，但我们还是建议在上架插件之前先查看商店有无功能一致的插件。如果你想要上架商店的插件的功能与现有插件的功能不完全重合，请在插件说明中补充与现有插件存在的区别。 + +同时，如果你参考或基于他人发行的代码进行开发，请注意遵守各代码所使用的开源许可协议。 + +## Git 工作流 + +`dev` 分支 为 NoneBot 的开发分支，如无特殊情况请将 Pull Request 提交到该分支。 + +如果你不是 NoneBot 团队的成员，可在 fork 本仓库后，向本仓库的 `dev` 分支发起 Pull Request 提交贡献，注意遵循先前提到的 commit message 规范创建 commit， diff --git a/README.md b/README.md index 1af8e081..114b79bc 100644 --- a/README.md +++ b/README.md @@ -167,11 +167,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ## 贡献 -如果你在使用过程中发现任何问题，可以 [提交 Issue](https://github.com/nonebot/nonebot2/issues/new) 或自行 Fork 修改后提交 Pull Request。 - -如果你要提交 Pull Request，请确保你的代码风格和项目已有的代码保持一致，遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/) 与 [PEP 484](https://www.python.org/dev/peps/pep-0484/)，变量命名清晰，有适当的注释与测试代码，**并且请以 `dev` 分支作为 Pull Request 目标分支**。 - - +请参考 [贡献指南](./CONTRIBUTING.md) ### 鸣谢 From ffab125f0252a4c86f6996f337a3a06d0082beb8 Mon Sep 17 00:00:00 2001 From: jigsaw Date: Thu, 27 Jan 2022 19:33:54 +0800 Subject: [PATCH 2/4] :memo: Update CONTRIBUTING Co-authored-by: Mix <32300164+mnixry@users.noreply.github.com> Co-authored-by: StarHeartHunt --- CONTRIBUTING.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d2874f1..6a05fb38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,17 +16,13 @@ NoneBot2 仍然是一个不够稳定的开发中项目，如果你在使用过 NoneBot2 还未进入正式版，欢迎在 Issue 中提议要加入哪些新功能。 -为了让其他开发者们更好地理解你的意图, 请认真填写预期行为等内容, 如果可能, 可以提出可行的解决方案猜想 +为了让开发者更好地理解你的意图，请认真描述你所需要的特性，可能的话可以提出你认为可行的解决方案。 ## Pull Request -### Commit 提交规范 +NoneBot 使用 [poetry](https://python-poetry.org/) 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。 -NoneBot 的 commit message 格式遵循 [gitmoji](https://gitmoji.dev/) 规范，在创建 commit 时请牢记这一点。 - -NoneBot 使用 [Poetry](https://python-poetry.org/) 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。 - -下面的命令能在已安装 Poetry 和 npm 的情况下帮你快速配置开发环境。 +下面的命令能在已安装 poetry 和 npm 的情况下帮你快速配置开发环境。 ```sh poetry install @@ -35,7 +31,11 @@ npm -g i gitmoji-cli gitmoji -i ``` -请确保你的每一条 commit 都有清晰的描述它做了什么, 一个 commit 尽量只做一件事情。 +### Commit 规范 + +请确保你的每一个 commit 都能清晰地描述其意图，一个 commit 尽量只有一个意图。 + +NoneBot 的 commit message 格式遵循 [gitmoji](https://gitmoji.dev/) 规范，在创建 commit 时请牢记这一点。 ### 撰写文档 @@ -55,12 +55,12 @@ NoneBot2 的代码风格遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/ 我们仅对插件的兼容性进行简单测试，并会在下一个版本发布前对与该版本不兼容的插件作出处理。 -虽然对插件的内容没有严格限制，但我们还是建议在上架插件之前先查看商店有无功能一致的插件。如果你想要上架商店的插件的功能与现有插件的功能不完全重合，请在插件说明中补充与现有插件存在的区别。 +虽然对插件的内容没有严格限制，但我们还是建议在上架插件之前先查看商店有无功能一致的插件。如果你想要上架商店的插件功能与现有插件不完全重合，请在插件说明中补充其与现有插件的区别。 同时，如果你参考或基于他人发行的代码进行开发，请注意遵守各代码所使用的开源许可协议。 ## Git 工作流 -`dev` 分支 为 NoneBot 的开发分支，如无特殊情况请将 Pull Request 提交到该分支。 +`dev` 分支为 NoneBot 的开发分支，如无特殊情况请将更改提交到该分支。 -如果你不是 NoneBot 团队的成员，可在 fork 本仓库后，向本仓库的 `dev` 分支发起 Pull Request 提交贡献，注意遵循先前提到的 commit message 规范创建 commit， +如果你不是 NoneBot 团队的成员，可在 fork 本仓库后，向本仓库的 `dev` 分支发起 Pull Request，注意遵循先前提到的 commit message 规范创建 commit。 From c4d08d13cb20350674163b6c11f13b1ddeb1e05f Mon Sep 17 00:00:00 2001 From: Jigsaw Date: Thu, 27 Jan 2022 21:44:31 +0800 Subject: [PATCH 3/4] :pencil2: Fix typo Co-authored-by: Ju4tCode <42488585+yanyongyu@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a05fb38..a3ab6a0b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ NoneBot 使用 [poetry](https://python-poetry.org/) 管理项目依赖，由于 ```sh poetry install -precommit install +pre-commit install npm -g i gitmoji-cli gitmoji -i ``` From 392def7936396955d981325d7b39f13d70a5cf92 Mon Sep 17 00:00:00 2001 From: jigsaw Date: Fri, 28 Jan 2022 13:14:59 +0800 Subject: [PATCH 4/4] :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) 一节。 我们仅对插件的兼容性进行简单测试，并会在下一个版本发布前对与该版本不兼容的插件作出处理。