调试与最佳实践
本地开发调试流#
推荐的基本循环:
- 在本地仓库开发插件,改动后保存
- 在 Web UI 中重新加载插件或重启 DSH,验证行为
- 用真实场景跑一遍,而不是只验证「不报错」
把 console 输出当作第一反应工具:在关键路径打日志,确认执行流与预期一致后再删。遇到环境层面的安装问题,参考安装失败排查。
版本管理#
- 采用语义化版本:
主版本.次版本.修订号,破坏性改动升主版本 - 每次发布打 git tag,让用户能用 commit-sha 精确锁定到任一版本
- 破坏性变更在 release notes 里写清楚迁移步骤
维护 CHANGELOG#
仓库根目录放一份 CHANGELOG.md,按版本列出新增、修复与变更。用户升级前看一眼就能评估风险,这比让他们翻 commit 历史友好得多。
社区响应#
- issue 尽量在一周内给出首次回应,哪怕是「已知悉,待排期」
- README 保持与最新版本一致,过时的安装说明是最劝退用户的东西
- 不打算继续维护时,在 README 顶部明确标注,给人留出迁移时间
发布与收录#
改动推送到 GitHub 后,DSHub 会在每日同步时更新展示数据。发布细节见发布插件到 DSHub。