Appearance
开发者招募
Mizuki Bot 长期维护文档、插件、网关服务和周边工具。我们欢迎能稳定协作的人加入,而不是短期堆功能。
我们需要什么
文档维护
整理功能说明、修正文案、补充截图和排查常见问题。适合熟悉 Bot 使用流程、能把复杂操作写清楚的人。
前端与文档站
维护 VitePress 站点、改进信息结构、优化移动端体验、处理搜索和无障碍问题。适合熟悉 Vue、CSS、VitePress 或静态站点部署的人。
插件与服务
参与 Mizuki Bot 生态插件、数据网关、自动化工具和运维脚本。适合熟悉 JavaScript、TypeScript、Node.js、Python 或后端服务的人。
协作原则
- 先读现有文档和代码,再提出改动。
- 小步提交,避免一次 PR 混入无关修改。
- 写清楚改动原因、影响范围和验证方式。
- 尊重用户体验,不为炫技牺牲可读性和稳定性。
加入方式
如果你想参与维护,可以先从以下事项开始:
- 阅读帮助文档和关联项目说明。
- 在 GitHub 提交 Issue,说明你想改什么、为什么改。
- 从小型文档修正或样式问题开始提交 PR。
- 如果需要长期协作,再联系维护团队加入内部沟通渠道。
适合的改动
- 修复错别字、过期链接和失效说明。
- 补充缺失功能文档。
- 改善页面层级、导航和搜索体验。
- 优化移动端阅读、键盘操作和无障碍细节。
- 为插件或工具补充部署、使用和排错说明。
不建议的改动
- 大量堆叠装饰动画。
- 没有验证的功能说明。
- 一次 PR 同时修改文案、样式、构建和部署。
- 只追求视觉冲击、但降低可读性的设计。
