ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-12-18 09:25:46 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

📝 Update CONTRIBUTING

Browse Source 
Co-authored-by: Mix <32300164+mnixry@users.noreply.github.com>
Co-authored-by: StarHeartHunt <starheart233@gmail.com>
This commit is contained in:
jigsaw 2022-01-27 19:33:54 +08:00
parent 2924c74333
commit ffab125f02
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -16,17 +16,13 @@ NoneBot2 仍然是一个不够稳定的开发中项目，如果你在使用过
NoneBot2 还未进入正式版，欢迎在 Issue 中提议要加入哪些新功能。 NoneBot2 还未进入正式版，欢迎在 Issue 中提议要加入哪些新功能。
为了让其他开发者们更好地理解你的意图, 请认真填写预期行为等内容, 如果可能, 可以提出可行的解决方案猜想 为了让开发者更好地理解你的意图，请认真描述你所需要的特性，可能的话可以提出你认为可行的解决方案。
## Pull Request ## Pull Request
### Commit 提交规范 NoneBot 使用 [poetry](https://python-poetry.org/) 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。
NoneBot 的 commit message 格式遵循 [gitmoji](https://gitmoji.dev/) 规范，在创建 commit 时请牢记这一点。 下面的命令能在已安装 poetry 和 npm 的情况下帮你快速配置开发环境。
NoneBot 使用 [Poetry](https://python-poetry.org/) 管理项目依赖，由于 pre-commit 也经其管理，所以在此一并说明。
下面的命令能在已安装 Poetry 和 npm 的情况下帮你快速配置开发环境。
```sh ```sh
poetry install poetry install
@ -35,7 +31,11 @@ npm -g i gitmoji-cli
gitmoji -i 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 工作流 ## Git 工作流
`dev` 分支 为 NoneBot 的开发分支，如无特殊情况请将 Pull Request 提交到该分支。 `dev` 分支为 NoneBot 的开发分支，如无特殊情况请将更改提交到该分支。
如果你不是 NoneBot 团队的成员，可在 fork 本仓库后，向本仓库的 `dev` 分支发起 Pull Request 提交贡献，注意遵循先前提到的 commit message 规范创建 commit， 如果你不是 NoneBot 团队的成员，可在 fork 本仓库后，向本仓库的 `dev` 分支发起 Pull Request，注意遵循先前提到的 commit message 规范创建 commit。