利用5w1h写出高效的git commit

223 阅读1分钟

创建git commit 模板

创建模板

在个人目录下, 创建 .gitmessage

vi .gitmessage

并输入以下信息

Who: Demand maker

*

When: versions affected

*

What:The content of the code changes

* descrption:
* wiki/task:

Why:The reason

*

How:Influence of change

*

命令与模板生效

在个人目录下,创建.gitconfig

vi .gitconfig

并输入以下信息

[user]
	name = ***
	email = *** 
[alias]
    st = status
    ci = commit
    br = branch
    co = checkout
    df = diff

[commit]
    template = ~/.gitmessage
    

使用模板

git commit 

模板解释

  • Who: Demand maker
    指需求的创建者、提出者或者是推动者;有助于今后排查是谁的需求。 那你可能要问为啥不写是谁写的代码呢?额:因为已经有了

  • When: versions affected 这里指的本次改动影响的版本,或者是哪个版本生效,特别针对于提供给客户端的接口,对于后期业务变动很重要

  • What:The content of the code changes 简单明了指名改动的内容,如果比较复杂可以附上wiki或task

  • Why:The reason 改动的原因,即改动会带来什么样的实际效果

  • How:Influence of change 改动对代码或业务造成的影响

参考

本文章参考了大神的文章:https://juejin.cn/post/6844903477395619847,非常感谢