如何报告问题
一份高质量的缺陷报告能让问题定位速度提升数倍。学习如何复现、收集日志并提交有效反馈。
报告前先做两件事
先确认你使用的是最新版本,很多问题在新版本中已经修复;再在社区与既有 issue 中搜索一次,避免重复提交。如果是使用问题而非软件缺陷,优先在社区论坛或希爱设计微信交流群提问。
一份好报告包含什么
- 一句话描述问题与影响范围
- 稳定的复现步骤(从打开文件开始)
- 预期结果与实际结果的对比
- 环境信息:浏览器及版本、操作系统、希爱设计版本或自托管版本
- 截图或录屏,标注出异常位置
- 自托管用户请附上相关组件的日志片段
- 必要时提供最小复现文件(删除敏感内容后)
自托管问题的附加信息
- 说明部署方式(Docker Compose 或 Kubernetes)与版本号
- 附上后端、实时协作、导出等相关服务的日志
- 说明最近是否做过升级、迁移或配置变更
- 标注问题是否可在官方演示环境复现
安全问题
安全问题
发现可能涉及安全的漏洞时,不要在公开 issue 中披露细节,请通过私下渠道(安全邮箱或希爱设计客服)报告,维护者会优先响应并协调修复。
实用提示
- 录屏时把操作路径完整拍下来,比长段文字更有效。
- 问题解决后回到原帖补充结论,能帮助后来遇到同样问题的人。