bilibili/WebAV

提问的技巧

Opened this issue · 2 comments

提出问题、回答问题都需要消耗时间,我们应以最小的成本,最大化问题(Issue)的价值
你应当将提交 Issue 视为对社区的贡献,而不只是为了让项目维护者来帮助你解决问题。

因此,提问之前你必须为解决该问题而努力过

  1. 查询过 Issues 列表、使用搜索引擎搜索过相关资料
  2. 调试分析过自己的代码,切忌遇到问题就扔出代码期望别人帮你调试

如果确定要创建 Issue,须了解 Issue 跟聊天时提问的(口语)模式不同;
Issue 是书面表达,应该用语简练,一次性提供详实的上下文信息,尽量避免他人追问基础信息

第一步,区分是“咨询问题”还是“反馈Bug”

咨询问题

  1. 完整地描述问题,模式:在什么场景下实现什么功能,过程中碰到了什么问题?
    • 第一个“什么”是环境(上下文)信息,第二个“什么”是目的,第三个“什么”是真实问题。
    • 典型错误是,描述自己的解决方案,然后咨询该方案如何实现
  2. 总结你已经做过哪些努力,已获得的信息
  3. 站在回答者的角度,让你的问题易于被回答

反馈 Bug

  1. 提供复现步骤,最好有可复现的项目 codesandboxstackblitz
    • 推荐基于官方 DEMO 代码创建新 stackblitz 项目
  2. 重点描述期望与实际结果的差异
  3. 你已经做过哪些验证行为,收集了哪些情报;(维护者不喜欢在未确认 Bug 的情况下花时间帮你调试代码
  4. 提供相关环境信息:操作系统、浏览器、WebAV 版本等等

该 Issue 会尽量保持简洁,让读者能快速阅读完毕;
如果你还想提高自己的“提问技巧”,可参考:提问的智慧

有以下特征的 issue 可能在未回复的情况下直接关闭。

  1. 问题描述不清晰;未提供足够信息
  2. 代码不可阅读;包含太多无关的业务代码,或没有语法高亮

已提交的 issue 若发现样式问题,可点击右上角的 ···再次编辑优化内容
image

批评一个东西最好的方式是改善它,让它变得更好。 ----凯文·凯利