milestones specification - sibbay-ai/public GitHub Wiki

小白 ICP 体系 - 里程碑规范

编写者:@ben7th
更新时间:2017-11-22

综述

小白众合工作通过 github milestone 对开发工作的内容与时间节点进行管理;
所有开发工作相关的 issue 需放入里程碑;

里程碑的命名

里程碑需按照 工作 - 版本号 的方式来命名;例如:
健康日记 - 1.5.0 众合体系 - 0.1

部分工作可能在一开始是相对临时的,不具可迭代性,建议可以 0.1 来标识里程碑版本号;
这样做的目的是,当工作内容发生增加时,避免出现一个一直不能关闭的里程碑

里程碑的完成时间

里程碑在创建后,需尽快标记截止时间。截止时间不要求精确无误差,但需要有理有据;
负责里程碑的 committer 需要尽快落实里程碑的时间依据;

当里程碑时间出现变更,需要由 committer 发一个 issue 来说明变更的原因;

里程碑的发起

当打算开始进行一项工作时,需发一个新的 issue, 说明该工作目前已知的情况,已知的参与者,或者需要招募的参与者;
所有便于组织内其他开发者理解工作内容,理解需求,有助于进行时间和风险评估的内容,都放入里程碑发起的 issue;
同时,建立里程碑,将该 issue 放入,并尽快确定里程碑完成时间;

里程碑的过程管理

所有与该工作相关的 issue, 创建后即放入该里程碑;committer 应注意及时把未正确指定里程碑的 issue 放入对应里程碑;

跨版本库的里程碑

一些工作会同时涉及多个代码工程(版本库),当出现这种情况,而对应版本库内又没有对应里程碑时,可在对应版本库创建一个完全同名的里程碑,并将 issue 加入;管理工具 codetree 将可以比较好的处理这些 issue 的合并;

里程碑的关闭

里程碑的关闭需要满足两个条件:

  • 里程碑中的所有 issue 被关闭;
  • 里程碑涉及的工作已经产生效果;

当满足条件时,由 committer 关闭里程碑(所有版本库下的同名里程碑)

里程碑的变更

  • 比较小的变更,作为时间变更,发 issue 说明原因(见前文)
  • 比较大的变更,或工作增加,committer 考虑后,可发新的里程碑,命名增加版本号;