译者注:这篇文章对于平时在论坛提问的人同样有帮助。
通告:我受雇于Zend 开发 Zend Framework。即下面的话都是我自己的观点,根据开发Zend Framework、以及回答邮件列表中各种各样问题和其它OOS项目(特别是PEAR, Solar, 和Cgiapp)的经验所得。
在OOS中最让我生气的一件事情就是模糊的bug/issue报告和特性请求。我简直数不清我曾经见过多少个这样的报告:
<Feature X> doesn't work; you need to fix it now!
如果这样的报告给一个问题跟踪者,总会被标记为批评或高优先级。
那什么令我苦恼呢?简单来说,它没有给负责维护Feature X 的人任何信息来展开工作:他们收到的结果是什么样子的,期望的是什么,或者他们如何使用这些特性的。报告接收者不得不进入一个或多个周期和报告者获取信息——浪费彼此的时间的精力。
略好一些的是这样的报告:
<Feature X> doesn't work -- I keep getting <Result X> from it, which is incorrect.
至少说明报告的是什么,但还是没有说明他们怎么会发现这个bug,或者他们期望的是什么。
所以,当你提交问题报告或者提出新特性请求的时候应该牢记下面这些问题:
- What is the minimum code necessary to reproduce the issue or show the desired API?
- 预期的结果是什么?
- 实际的结果是什么?