MuiceBot 贡献指南

非常感谢大家产生了为 MuiceBot 贡献代码的想法，本指南旨在指导您如何科学规范地开发代码，还请在撰写代码前仔细阅读

报告问题

MuiceBot 目前仍然处于早期开发状态，暂未有提交正式版的想法，因此部分功能可能存在问题并导致机器人运行不稳定。如果你在使用过程中发现问题并确信是由 MuiceBot 运行框架引起的，请务必提交 Issue

MuiceBot 还未进入正式版，欢迎在 Issue 中提议要加入哪些新功能， Maintainer 将会尽力满足大家的需求

从 2025.07.04 开始， Muicebot 将开始转向使用 gitmoji 作为主 commit 规范

📝 更新 Commit 规范

当然，我们也欢迎 Angular 规范

docs: 更新 Commit 规范

无论使用何种 Commit 规范，请确保每一个 Commit 只代表一个意图，并清晰地描述其目的。

包含诸如 fixed、update、change 等无法清晰表达修改意图的 commit 信息的合并请求将被拒绝。

MuiceBot 使用 pre-commit 进行代码规范管理，因此在提交代码前，我们推荐安装 pre-commit 并通过代码检查：

pip install .[standard,dev]
pip install nonebot2[fastapi]

pre-commit install

目前代码检查的工具有：flake8 PEP风格检查、mypy 类型检查、black 风格检查，使用 isort 和 trailing-whitespace 优化代码

在本地运行 pre-commit 不是必须的，尤其是在环境包过大的情况下，但我们还是推荐您这么做

代码提交后请静待工作流运行结果，若 pre-commit 出现问题请尽量先自行解决后再次提交

MuiceBot 使用 rspress 作为文档站，你可以直接在 docs 文件夹中使用 Markdown 格式撰写文档。

如果你需要在本地预览文档，可以使用 npm 安装 rspress 依赖后启动 dev 服务：

npm install
npm run dev