Skip to content

完成标准(DoD)

Lei Xu edited this page Feb 25, 2020 · 5 revisions

真正把事情做完(Done),实现內建质量(Build-In Quality),才能让我们快速奔跑,所以我们需要约定好完成标准(Definition Of Done)。

本文档定义了Boat House开源共创项目的完成规范,请共创团队以及社区贡献者遵照执行,维护团队在review PR时按照此标准执行。

关于Issue的DoD

1. 提交Issue,需要采用用户故事的形式

  • “作为一个xxx, 我想/希望xxxxx,以便xxxx”

我们鼓励大家按照以上用户故事标准模板编写自己的Issue,对于无法通过此范式描述的内容。请自行在Issue描述中补齐,包括可以提交附件/图片等内容,力求帮助阅读者充分准确的了解你的需求。

Issue提出者需要对自己提出的Issue负责,针对社区的反馈及时做出答复。建议Watch boat-house主库,并确保你的通知邮件可以被技术阅读。

2. 提交的Issue,需要具备验收标准(AC=Acceptance Criteria)

  • 满足。。。
  • 满足。。。

验收标准非常重要,你需要明确希望通过此Issue而达成的目的。维护团队会协助你明确这些内容并在review PR的时候按照约定的AC进行评审。

3. 关于Issue提交PR的要求

  1. 自测通过
  2. 符合对应的全部AC要求
  3. 找另外伙伴评审通过
  4. 对应的文档补充完整
  5. Issue完成内容需要准备完整的演示脚本,可以在迭代评审会上按照演示脚本进行演示
  6. 相关代码针对boat-house主库发起PR,代码结构符合主库当前结构(后续可能会调整主库接口,包括进行拆分,请各团队持续关注维护团队发布的信息)
  7. 相关文档和演示脚本针对boat-house-devops实践库发起PR,文档结构符合实践库当前结构
  8. 发起PR的同时,请发起人关联Issue ID以便跟踪

完成一个Issue代表着你的贡献将被boat-house项目接受,同时也代表着你的贡献将会被整个社区共享,这是一个神圣而且严肃的时刻。我们希望所有的贡献者都能充分发会自己的创造力和能力,同时也希望大家在社区的贡献可以更容易的被其他人分享。因此,对于每次PR的内容我们需要大家遵照这些规范以便可以让更多的人分享到你的成果。