Git commit注释规范

指定规范的提交格式, 方便后期版本的回滚与记录的查询

 

格式规范:

<type>(<scope>): <subject>
// 空一行
<body>

范例:

fix: feat(0429留言下单): add 'graphiteWidth' option

提交的具体情况
  •   type:说明commit的类别, 只允许使用下面8中标识
    •   br:针对bug号,用于项测试反馈bug列表的bug修改情况
    • feat:新功能
    • fix:修复bug
    • docs:文档
    • style:格式(不影响代码运行的变动)
    • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    • test:增加测试
    • chore:构建过程或辅助工具的变动
    • revert:feat(pencil): add 'graphiteWidth' option (撤销之前的commit)

 

  •   scope:用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
    •   subject:subject是 commit 目的的简短描述,不超过50个字符。
    • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
    • 第一个字母小写
    • 结尾不加句号(.)

 

  •   body:Body 部分是对本次 commit 的详细描述,可以分成多行

 

posted @ 2021-12-22 09:41  X-Wolf  阅读(1029)  评论(0编辑  收藏  举报