问题反馈
# 一般问题反馈
简要描述在执行哪些操作时,遇到的问题现象,以及已经尝试过的解决方法。
# 复杂类问题反馈
- 说明当前使用的版本;
- 说明发生问题的模块;
- 说明已经尝试过的解决方案:
- 有无查找帮助文档;
- 有无查找 Issue 列表;
- 有无进行 Debug;
- 详细描述复现步骤;
- 附带上异常截图、异常栈(务必完整):
- 如果可能,请提供完整的屏幕截图;
- 代码如有打印输出,请提供完整的打印输出内容。
如何反馈一个高质量的问题?
- 提供问题的清晰描述,描述具体缺失、过时、错误的内容或者需要改进的文字。
- 解释该问题对用户的影响。
- 将给定问题的范围限定在一个具体内容、任务。如果问题牵涉的领域较大,可以将其分解为多个小一点的问题。例如:"文档需要优化" 是一个过于宽泛的问题,而 "XX开发指南缺少对XXX步骤的介绍" 就是一个足够具体的、可操作的问题。
- 搜索现有问题的列表(gitee issues (opens new window) | github issues (opens new window),查看是否已经有相关的或者类似的问题已被记录。
- 如果新问题与某其他问题或 PR 有关联,可以使用其完整 URL 或带 # 字符的 PR 编号 来引用它。
如何在社群中高效提问?
- 社群(QQ群、微信群、Gitter等)中消息比较多而杂,为了更好的解决你的问题,我们建议优先选择 issue(gitee issues (opens new window) | github issues (opens new window)
- 在社群中提问时尽量采用完整、清晰的描述,不建议此类问题,比如:“xx怎么用?”、“为什么我的报错?”、或者直接发一张异常截图不加描述,对于此类问题,我们可能会选择忽略。
- 提问前推荐阅读 《提问的智慧》 (opens new window)、《如何向开源社区提问题》 (opens new window) 和 《如何有效地报告 Bug》 (opens new window)、《如何向开源项目提交无法解答的问题》 (opens new window),更好的问题更容易获得帮助。
Last Updated: 2021/09/20, 21:52:28