千恋*万花

  • 首页
  • 个人简历
  • 文章分类
    • 后端开发
    • 运维
    • 基础知识
    • 笔记
    • 工作运维记录
    • 随笔
    • 未分类文章
萌奈の笔记簿
分享我的努力,希望为你助力
  1. 首页
  2. 笔记
  3. 正文

自用简易的git commit消息规范

2022-10-11 3561点热度 0人点赞 0条评论

参考:阮一峰的网络日志 《Commit message 和 Change log 编写指南》

Commit message 的格式

<type>(<scope>): <subject>       ------ Header(必须)
// 空一行
<body>                             ------ Body(可选)
// 空一行
<footer>                       ------ Footer(可选)

当使用 git commit -m 命令时,提交的单行commit应写 Header 的内容。

header 规范

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)。

(1)type

用于说明 commit 的类别,只允许使用下面7个标识。

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

(2)scope

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

(3)subject

subject是 commit 目的的简短描述,不超过50个字符。

  • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 第一个字母小写
  • 结尾不加句号(.)
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可
标签: Git git commit
最后更新:2022-10-27

初音萌奈

我是练习时长 三年半 的后端开发程序员 谢谢你参观我的博客! 本网站现已支持IPv6 ☞ 个人简历 ☜

点赞
< 上一篇
下一篇 >

文章评论

razz evil exclaim smile redface biggrin eek confused idea lol mad twisted rolleyes wink cool arrow neutral cry mrgreen drooling persevering
取消回复
文章目录
  • Commit message 的格式
    • header 规范

COPYRIGHT © 2025 HatsuneMona ALL RIGHTS RESERVED.

Theme Kratos Made By Seaton Jiang

晋ICP备17007130号-4