错误报告规范

1. PR 类型包括如下

类型	范例
BugFix [BugFix]	修正某个坏掉的功能
HotFix [HotFix]	紧急修正某个奇怪的东西
CS [CS]	修正 Coding Style
Feature [Feature]	写了某个新功能
Update [Update]	改了某个文字档
Refactor [Refactor]	重构了某个功能

2. 当 PR 有相对应的 issue 号码时，建议加在 PR 类型后面，举例如下

PR	标题范例
[Feature #90]	写了某个新功能
[BugFix #119]	修正某个坏掉的功能

3. PR comment
   有相关的 issue 时在 comment 内列出范例如下：

PR comment	范例
修正 #123	Fixed #123
完成 #123 #90	Finish #123 #90
完成 #123 在 #90 之后 merge	Finish #123 merge after #90

4. close issue
   关闭 issue 时请填写关闭的理由.几种关闭的理由列举如下

close issue comment example
closed by #123
该 issue 已有结论
该 issue 已结案

5. commit message (建议写法，不强制规定)
   有相关的 issue 时在 commit message 内列出
   commit message 的格式如下

commit message balabalba (issue #123)

主要的规则是在原本的 commit message 后加上括号，括号内填写 issue 的编号

范例如下：

commit message 范例
Do something well (fixed #107)
fixed the bug of the category counts (issue #123)
complete feature balabala (for #123)
complete feature balabala. for #123

可自动关闭 issue 的语法统整
fix #xxx
fixes #xxx
fixed #xxx
close #xxx
closes #xxx
resolve #xxx
resolves #xxx
resolved #xxx

---

错误报告规范

SSCCE原则

• 简短(short)
• 自足(self-contained)
• 正确(correct 正确编译并运行)
• 例子(example)

错误报告必须具备的东西:

• 精确的标题(precise title)
• bug优先级(priority)
• 严重程度(severity)
• 受影响的利益相关者(stakeholder)
• bug发生情景(environment)

参考: https://github.com/lyrasoft/development-tools/issues/22