首先 fork 本项目,然后克隆并安装:
git clone [email protected]:YOUR_USERNAME/nonebot
cd nonebot
pip install -e . # 注意点号
目前本项目没有单元测试。如需贡献新功能或修复 bug,请在提交 PR 之前做好测试,并在 PR 中提供测试过程和结果。
请使用 Flake8 确保代码风格正确:
flake8 --config .flake8
另外,变量、函数、类、方法、模块等的命名应与项目其它部分一致,且含义清晰。以下划线开头的的标识符表示文件内部的定义,不以下划线开头但是注释标明为 "INTERNAL API"
的函数和类等也表示模块内部的 API。
其余标识符表示 NoneBot 暴露在外的 API,这些 API 应该包含在对应文件的 __all__
列表中且在 API 文档 中注明。
项目文档在 docs
目录,当添加新功能或修改已有功能时,应同时修改文档的 api.md
和 changelog.md
对应部分,在功能尚未发布时,在 api.md
中应使用 <Badge text="master"/>
标记,在 changelog.md
中应填写在 ## master
二级标题下。
在你 fork 的仓库的「Pull requests」页面,点「New pull request」可提交 PR,具体细节请参考网上教程。
请在 PR 中解释该 PR 所做的事情,和相关测试结果等。
最后,感谢你的贡献!