规范git的提交信息

来源:互联网 发布:阿里云服务器免费试用 编辑:程序博客网 时间:2024/06/05 18:00

之前在项目中写commit message比较随意,每次改完代码都随手写了个fix,后来也因此吃了个亏,所以痛下决心改了这个不好的习惯。看了看目前使用比较广泛的Angular的规范。决定以后将commit message修改如下。

<type>(<scope>): <subject><body><footer>

type:

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

scope

scope用于说明 commit 的修改范围,比如列出修改的文件什么的。

subject

subject是 commit 目的的简短描述

body

本次 commit 的详细描述,可以分成多行。每行不宜太多内容,防止自动换行。

footer

针对某个issue,可以在 footer 部分关闭这个 issue 。Closes #243

一般情况下 ,为了便于查看提交信息,头部一定要这么写<type>(<scope>): <subject>

1 0
原创粉丝点击