Change log 编写指南

Change log 编写指南

git commit -m “清晰明了说明提交的目的”

commit message 作用:

  1. 提供更多历史信息,方便快速游览
    • git log <last tag> HEAD --pretty=format:%s // 显示上次发布后的变动
    • 每个commit占一行,只看行首就知道某次commit的目的
  2. 过滤某些commit
    • git log <last release> HEAD --grep feature // 仅显示本次发布新增加的功能
  3. 生成change log
    • 发布新版本时,说明与上一个版本差异的文档

格式:
每一行不能超过72个字符
包括 header(必须)、body、footer 三个部分

header(三个字段):
*type字段:提交类别,以下7个标识
- feat:新功能(feature)(默认写入change log)
- fix:修补bug ,(默认写入change log)
- docs:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
*scope(可选):说明commit 影响范围
*subject字段: commit目的描述,50字符以下

body

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容