提交 Issue 前请阅读:Issue 规范指南
👋 欢迎
感谢你关注 Songloft!无论是报告 Bug、提出建议还是寻求帮助,每一个 Issue 都对项目改进很有价值。
为了让大家的问题更快得到回应,请在提交前花 1 分钟阅读以下指南。
📋 选择合适的模板
点击 New Issue 时会看到以下模板,请选择最匹配的:
| 模板 | 适用场景 |
|---|---|
| Bug 报告 | 发现了不符合预期的行为,需要修复 |
| 功能建议 | 希望添加新功能或改进现有功能 |
| 使用问题 / 咨询 | 部署、配置、使用上遇到了困惑 |
| 插件相关问题 | JS 插件的 Bug、建议或使用问题 |
如果以上模板都不合适,也可以创建空白 Issue。
✅ 提交前 Checklist
- 搜索已有 Issue:你的问题可能已经有人提过了。善用 Issue 搜索,关键词尽量简短精确
- 提供版本信息:Songloft 服务端版本 + 客户端平台,这是排查问题的基础
- 附上日志或截图:Bug 类 Issue 请尽量附上相关日志(Docker 用户:
docker logs songloft) - 一个 Issue 只描述一个问题:多个问题请分开提交,方便跟踪
- 不要在无关 Issue 下回复新问题:如果你的问题和某个已有 Issue 无关,请新建一个 Issue,不要在别人的 Issue 下面评论。无关回复会干扰原 Issue 的讨论,也会让你的问题难以被跟踪和解决
💡 标题怎么写
好的标题能让维护者一眼看出问题所在:
| ✅ 好的标题 | ❌ 不好的标题 |
|---|---|
| Web 端播放 HLS 电台无声音 | 播放有问题 |
| Docker 部署后扫描目录为空 | 不能用 |
| 建议:支持按专辑分组显示 | 建议 |
| MIoT 插件语音指令响应延迟 30s+ | 插件问题 |
🏷️ 关于子仓库 Issue
如果你的问题涉及以下子项目,请到对应仓库提交:
- 客户端(Flutter):songloft-player
- 插件工具链:plugin-toolchain
- 具体插件:到各插件仓库提交(如 songloft-plugin-miot)
不确定问题出在哪个仓库?没关系,直接在本仓库提交即可,我们会帮你转移。
感谢你的耐心阅读,期待你的反馈! 🎵
评论
没有评论。 链接到 GitHub Issue
