release changelog相关

41 阅读1分钟

所有人 针对近期commit message出现的问题,现规范如下。

1,Title要求,以版本Va.b.c.d为例:

如果只是版本d更新,参考示例:

fix xxx isssue

add support for xxx

如果c以上的版本更新,参考示例:
roll to va.b.c to fix xxx issue
roll to va.b.c to support xxx

以上,xxx选本次提交最主要的修改即可。

禁止没有任何有效内容的common title,如bug fix

2,Log要求,动宾短语,必须cover本次提交的所有修改内容,事无巨细:

  • Add feature
  • Remove feature
  • Change feature or fix bug

一句话描述不清楚的,用NOTE详细描述,fix jira bug的,要把jira链接贴上。

与chip相关的tool,VERIFICATION必须描述清楚验证的环境,比如:

Test OK on AmebaSmart QA730EL0-1V0

change log 中不能出现D的增加,因为release的时候最少都是c的改变,所以只能改c,不同时间可以在c的更改之追加。