commit message 规范

标签: git   commit  脚本化 多人合作 前端
14人阅读 评论(0) 收藏 举报
分类:
(这段时间做项目发现,多人合作时或者查看自己修改的以前版本,即使描述很清晰,
一天提交很多版本的情况下,也要逐一仔细查看变化,不是很直观)  

下面分享下这两天用的Commit message 的格式:  

1.对比  

2.前提:  
每次本地代码改动提交到远程,需要注明提交说明,否则不允许提交到远程
```
git commit -m "hello word" // -m: 指定hello word
```
提交多行信息:
```
git commit // 跳出文本编辑器,写多行信息

```

3.commit message 格式  
每次提交,包括三个部分: header, body, footer
```
<type>(<scope>): <subject> // 必须
<body> // 可省略
<footer> // 可省略
```
解释:
type: 提交类别(下面基本会覆盖提交代码所需,建议只出现下面7种类别,多了会更乱)
feat:新功能(feature)  
fix:修补bug  
docs:文档(documentation)  
style: 格式(不影响代码运行的变动)  
refactor:重构(即不是新增功能,也不是修改bug的代码变动)  
test:增加测试  
chore:构建过程或辅助工具的变动  
scope:影响范围(可不写)  
subject:对改变的正常描述,最好以动词开头语(尽量详细,必填)  
body:详细描述(个人认为没必要,可不写)  
footer:修改不兼容变动以及关闭   Issue时(个人认为没必要,可不写)  
### 4.撰写合格 Commit message 的工具----Commitizen
 
安装:
```
npm install -g commitizen
```

在项目目录里运行

```
commitizen init cz-conventional-changelog --save --save-exact
```
END: 以后凡是用git commit命令 就换成  git cz 
这样会自动提示以上几个类别

5.建议不必安装Commitizen工具,自己强制写几天就记住这七种类别了,安装校验反而积累



> 更多内容:  
> https://lixiaoyu2017.github.io/  
> 参考文章:  
> http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html  















查看评论

怎么写一个好的 Git commit message

网络上很多关于 commit message 的想法都来源于 tpope,在他看来,一个好的 Git commit messge 应该是这样的: Capitalized, short (50 ch...
  • simple_the_best
  • simple_the_best
  • 2017-10-10 08:46:33
  • 2055

SVN提交时commit Log写法

n使用关键字来描述提交的代码引用了哪些问题、解决了哪些问题。用于解决问题的关键字后问题的变更设置:应用后的状态和完成度 n默认的关键字有: n引用:refs, references, IssueI...
  • huaishu
  • huaishu
  • 2014-10-11 10:52:18
  • 2859

git commit 时检查comment消息格式

之前大家普遍遇到在本地commit 时,由于comment消息格式写错,导致无法push的情况。 有一个策略,可以避免这种困难: 就是我们在commit时,就立刻检查comment消息格式,如果不符合...
  • CrazyZhang1990
  • CrazyZhang1990
  • 2014-12-11 13:15:10
  • 3680

Git Commit的日志格式规范

提交规则 一个commit只做一件事情;若一个commit做了多件事情需要拆分成多个commit严格遵循commit message格式每次只允许提交一个commit,若本地有多个commit等...
  • wxs0124
  • wxs0124
  • 2016-07-18 11:07:58
  • 2177

git commit 提交注释规范

本文将介绍使用git commit时的注释规范,提高commit内容的可读性及理解。
  • fdipzone
  • fdipzone
  • 2015-11-28 22:20:36
  • 17067

写出好的 commit message

为什幺要关注提交信息 加快 Reviewing Code 的过程帮助我们写好 release note5年后帮你快速想起来某个分支,tag 或者 commit 增加了什么功能,改变了哪些代码让其...
  • twlkyao
  • twlkyao
  • 2013-12-26 17:06:40
  • 1349

ERROR: missing Change-Id in commit message footer

在使用git推送到远程服务器的时候出现了如下错误: remote: Change-Id: I6be0d3bc768b24b837223a55221403f4c65aff59 remote: E...
  • leedaning
  • leedaning
  • 2015-04-09 14:27:43
  • 3209

git 合并分支出现 Please enter a commit message to explain why this merge is necessary.

Please enter a commit message to explain why this merge is necessary. 请输入提交消息来解释为什么这种合并是必要的 ...
  • lhw413
  • lhw413
  • 2017-06-12 10:53:32
  • 884

初用 Git 小问题解决备忘录

创建库一般网络上说明 Git创建库的步骤是:mkdir “directory name“  #创建一个目录.cd  “directory name”  #进入目录git  init          ...
  • Viweei
  • Viweei
  • 2011-01-25 17:45:00
  • 23176

git 删除文件时出现:please enter the commit message for your changes

1.使用命令  git rm test.txt 删除版本库中文件,    下一步:git commit 提交    出现如图: 这是因为没有同时提交信息,即:git commit...
  • cvper
  • cvper
  • 2018-01-09 15:18:17
  • 426
    个人资料
    等级:
    访问量: 1024
    积分: 113
    排名: 122万+