git commit message——git提交日志规范备忘

2024-03-31 03:56:39

使用git提交时，最好能注意保持规范，可能某些公司对这方面没有要求，但是提交日志不规范的话，不方便查阅和管理。

在此记录下commit的类别，备忘，更详细的介绍，可以查看文末链接。

commit message格式说明

Commit message一般包括三部分：Header、Body和Footer。

Header

type(scope):subject

type：用于说明commit的类别，规定为如下几种

feat：新增功能；

fix：修复bug；

del: 删除

docs：修改文档；

refactor：代码重构，未新增任何功能和修复任何bug；

build：改变构建流程，新增依赖库、工具等（例如webpack修改）；

style：仅仅修改了空格、缩进等，不改变代码逻辑；

perf：改善性能和体现的修改；

chore：非src和test的修改；

test：测试用例的修改；

ci：自动化流程配置修改；

revert：回滚到上一个版本；

scope：【可选】用于说明commit的影响范围

subject：commit的简要说明，尽量简短

Body

对本次commit的详细描述，可分多行

Footer

不兼容变动：需要描述相关信息

关闭指定Issue：输入Issue信息

转自：https://blog.csdn.net/ligang2585116/article/details/80284819

更多：https://blog.csdn.net/y491887095/article/details/80594043

git commit message——git提交日志规范备忘相关推荐

Git学习总结（23）——Git commit message和版本管理规范总结
一.Git commit message基本规范对格式的说明如下: type代表某次提交的类型,比如是修复一个bug还是增加一个新的feature.所有的type类型如下: feat: 新增feat ...
Git Commit Message校验踩坑指南
背景在团队多人开发中,规范的commit message可以快速定位代码提交历史,回溯问题根源,方便组内多人协作,提高团队效率. 本篇文章主要包含以下两方面内容: commitizen/cz-cli ...
git commit 约定式提交
引言在开发中免不了和他人一起团队协作提交代码,为了防止大家每次提交代码时,git commit -m ' '的提交信息不明所以,所以Angular 团队提出了 Git 约定式提交.这只是一种约定规范 ...
【Git】git commit --amend 追加提交
使用场景当你提交了代码,结果发现代码中还有的地方要改善,可以通过git commit --amend来追加提交,这样就可以避免生成两次提交有以下两种情况: 1.如果还没有push到远程 g ...
git init、git status、git config user.name、git add、git commit、git remote、git push、git clone、git pull
1. Git本地仓库初始化 1.1 git init 功能 git init:初始化一个新本地仓库,它会在工作目录下生成一个.git的隐藏文件夹来管理仓库,千万不要删掉它. 1.2 git statu ...
git如何切换用户_git切换用户、多用户切换的正确方式 git commit和git push 切换用户...
由于最近自己搭建了一个GITLAB服务器,为了测试权限.所以会涉及到使用不用的用户进行git commit 和git push 操作. 通过百度搜索以后,发现绝大部分给的答案是: git config ...
Git commit message和工作流规范
总体方案 Git commit日志基本规范 <type>(<scope>): <subject><BLANK LINE><body>< ...
Aborting commit due to empty commit message git 提交
Aborting commit due to empty commit message 原因:提交空信息被终止了提交解决: 1.git commit -m '注释信息' 2.git commit 头 ...
commitizen和cz-customizable配置git commit message 1
起因团队对提交的commit message格式有约定俗称的要求,但是没有一个统一的规范,导致大家提交的commit message或多或少不太一样.因此,需要一个工具来帮助大家统一commit m ...

最新文章

热门文章