-- 创造无限可能

git:git commit规范

2022-05-13 19:08:20
379 人浏览 5 人点赞
有用,点赞支持一下

git commit 时候需要输入一个message,该message用于描述当前commit。一个恰当的commit可以让大家清晰的了解这次commit的内容。也方便以后回看的时候清楚知道每次commit

message格式

<type>[<scope>]:<subject>
//空一行
[<body>]

说明

type:本次提交的类型

  • build: 主要目的是修改项目构建系统(例如glup,webpack,rollup的配置等)的提交
  • ci:主要目的是修改项目继续完成集成流程(例如Travis,Jenkins,GitLab CI,Circle)的提交
  • doc:document,对应的文档更新
  • feat:feature,项目中的新增功能
  • fix: bug修复
  • pref:性能优化
  • refactor:重构代码(既没有新功能,也没有修复bug)
  • style:不影响程序逻辑的代码修改(更加规范,加入空白符,补全分号)
  • test:新增测试用例或是更新现有测试
  • revert:回滚某个更早之前的提交
  • chore: 不属于以上类型的其他类型

必须,scope可选,subject必须,body可选

scope:范围

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

subject:主题

subject是commit内容的尖端描述,不超过50个字符。
义动词开头,使用第一人称现在时,比如change,而不是changed或changes,第一个字母小写。结尾不加英文句号(.)

body:详细内容

Body部分是本次commit的详细描述,可以分成多行。