1. issue创建准则

1.1. 编写优秀的“功能” issue

如果你要录入一个新功能(需求)的 issue,最好在内容主体中包含下面这些内容:

  • 用一句话描述你的需求,并用它作为标题
  • 这个需求是解决什么问题的?
  • 这个需求对软件现有功能会造成什么影响?
  • 这个需求应该实现什么样的功能?
  • 这个需求是否依赖其他模块提供相关支持?
  • [可选] 这个需求有哪些实现方式?
  • [可选] 这些可选的实现方式分别有哪些优缺点?

1.2. 编写优秀的“bug” issue

如果你要录入一个 bug issue,最好在内容主体中包含下面这些内容:

  • 提供出现问题的软件版本号、操作系统环境等相关信息
  • 提供能够稳定复现问题的相关步骤
  • 描述期待行为与当前行为
  • [可选] 你对这个 bug 原因的相关分析

1.3. 编写优秀的“部署”issue

如果你要录入一个 部署 issue,最好在内容主体中包含下面这些内容:

  • 部署的机器
  • 部署的环境
  • 部署的项目
  • 所需的相关依赖

1.4. 编写优秀的“重构”issue

如果你要录入一个 重构 issue,最好在内容主体中包含下面这些内容:

  • 旧设计的不足,新设计的优越性。
  • 描述清楚新设计导致的结构改动和涉及哪些功能模块。
  • 新设计较于旧设计的提升。
  • 新设计对现有系统的影响。

1.5. 编写优秀的“调研”issue

如果你要录入一个 调研 issue,最好在内容主体中包含下面这些内容:

  • 调研的目标,内容
  • 调研过程中涉及的文献
  • 调研过程中,不同阶段时间花费情况
  • 调研结束后,输出总结文稿

results matching ""

    No results matching ""

    results matching ""

      No results matching ""