首页 / GIT / 前端技巧：git commit提交规范

前端技巧：git commit提交规范

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了前端技巧：git commit提交规范，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含5133字，纯文字阅读大概需要8分钟。

内容图文

在日常的开发工作中，通常使用git来管理项目代码，当对代码进行修改后，可以通过git commit命令来提交代码。

git 规定提交时必须要写提交信息，作为改动说明，保存在 commit 历史中，方便回溯。规范的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG，甚至对于项目的研发质量都有很大的提升。

但是在日常工作中，大多数同学对于 log 信息都是简单写写，没有很好的重视，这对于项目的管理和维护来说，无疑是不友好的。本篇文章主要是结合我自己的使用经验来和大家分享一下 git commit 的一些规范，让你的 log 不仅“好看”还“实用”。

为什么要规范commit message
一直在说要规范 commit message格式，那为什么要这样做呢？

让我们先来看一个不太规范的 commit 记录：
前端技巧：git commit提交规范 - 文章图片
看完以后什么感觉，这到底更新了什么啊，写得全是update，这种 commit 信息对于想要从中获取有效信息的人来说无疑是一种致命的打击。

那我们来看一个社区里面比较流行的Angular规范的 commit 记录:
前端技巧：git commit提交规范 - 文章图片
看完是不是一目了然呢？

上图中这种规范的 commit 信息首先提供了更多的历史信息，方便快速浏览。其次，可以过滤某些 commit（比如文档改动），便于快速查找信息。

既然说到了 Angular 团队的规范是目前社区比较流行的 commit 规范，那它具体是什么呢？下面让我们来具体深入了解下吧。

Angular 团队的 commit 规范
它的 message 格式如下:

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

分别对应 Commit message 的三个部分：Header，Body 和 Footer。

Header
Header 部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

type: 用于说明 commit 的类型。一般有以下几种:
feat: 新增featurefix: 修复bugdocs: 仅仅修改了文档，如readme.mdstyle: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。refactor: 代码重构，没有新增功能或修复bugperf: 优化相关，如提升性能、用户体验等。test: 测试用例，包括单元测试、集成测试。chore: 改变构建流程、或者增加依赖库、工具等。revert: 版本回滚
scope: 用于说明 commit 影响的范围，比如: views, component, utils, test...
subject: commit 目的的简短描述
Body
对本次 commit 修改内容的具体描述, 可以分为多行。如下图:

# body: 72-character wrapped. This should answer:
# * Why was this change necessary?
# * How does it address the problem?
# * Are there any side effects?
# initial commit

Footer
一些备注, 通常是 BREAKING CHANGE(当前代码与上一个版本不兼容) 或修复的 bug(关闭 Issue) 的链接。

简单介绍完上面的规范，我们下面来说一下commit.template，也就是 git 提交信息模板。

git 提交信息模板
如果你的团队对提交信息有格式要求，可以在系统上创建一个文件，并配置 git 把它作为默认的模板，这样可以更加容易地使提交信息遵循格式。

通过以下命令来配置提交信息模板:

git config commit.template   [模板文件名]    //这个命令只能设置当前分支的提交模板
git config  — —global commit.template   [模板文件名]    //这个命令能设置全局的提交模板，注意global前面是两杠

新建 .gitmessage.txt(模板文件) 内容可以如下:

# headr: <type>(<scope>): <subject>
# - type: feat, fix, docs, style, refactor, test, chore
# - scope: can be empty
# - subject: start with verb (such as 'change'), 50-character line
#
# body: 72-character wrapped. This should answer:
# * Why was this change necessary?
# * How does it address the problem?
# * Are there any side effects?
#
# footer:
# - Include a link to the issue.
# - BREAKING CHANGE
#

看完上面这些，你会不会像我一样感觉配置下来挺麻烦的，配置一个适合自己和团队使用的近乎完美的 commit 规范看来也不是一件容易的事情。不过社区也为我们提供了一些辅助工具来帮助进行提交，下面来简单介绍一下这些工具。

commitizen
commitizen是一款可以交互式建立提交信息的工具，可以自动生成合格的commit message

安装
npm install -g commitizen
在项目中使用
commitizen init cz-conventional-changelog --save --save-exact
commit
在提交的时候就可以使用 git cz 就可以根据提示，生成自动化的 commit message
前端技巧：git commit提交规范 - 文章图片
使用commitizen时，首先通过上下键控制指向你想要的 type 类型，分别对应有上面提到的feat、fix、docs、perf等，然后会让你选择本次提交影响到的文件，后面会让你分别写一个简短的和详细的提交描述，最后会让你去判断本次提交是否是BREAKING CHANGE或者有关联已开启的issue。最后，当时查看提交历史时，你会看到这样的commit message:

docs(docs): 更新README文件

validate-commit-msg
commitizen可以保证自己本地的commit message规范，但是无法保证队友也是规范的，所以需要其他工具来检测队友的提交记录是否规范。使用validate-commit-msg 检查队友的commit message规范

安装
npm install validate-commit-msg husky -D
添加package.json文件配置
"husky": {"hooks": {"commit-msg": "validate-commit-msg"}}
自定义校验格式（可选）
添加一个.vcmrc文件，配置对象如下：
{"types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"],"scope": {"required": false,"allowed": [""],"validate": false,"multiple": false},"warnOnFail": false,"maxSubjectLength": 100,"subjectPattern": ".+","subjectPatternErrorMsg": "subject does not match subject pattern!","helpMessage": "","autoFix": false}
提交
示例：git commit -m 'feat(main.js): 添加路由'
生成CHANGELOG
conventional-changelog 安装
npm install -g conventional-changelog-cli
# 生成CHANGELOG.md，并覆盖掉以前的内容conventional-changelog -p angular -i CHANGELOG.md -s -r 0# 生成所有发布的 Change logconventional-changelog -p angular -i CHANGELOG.md -w -r 0
注意事项
conventional-changelog -p angular -i CHANGELOG.md -w只能在命令行中 log 出 CHANGELOG 的内容，不会生成文件，如果要生成文件需要使用 conventional-changelog -p angular -i CHANGELOG.md -s。更多的 config 可以使用 conventional-changelog --help 查看*

内容总结

以上是互联网集市为您收集整理的前端技巧：git commit提交规范全部内容，希望文章能够帮你解决前端技巧：git commit提交规范所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/1035385.html

来源：【匿名】

【上一篇】Gitee——搭建个人博客网站【下一篇】细说git分区管理详解

更多 ►

【前端技巧：git commit提交规范】教程文章相关的互联网学习教程文章

git reset commit

原文链接写完代码后，我们一般这样git add . //添加所有文件git commit -m "本功能全部完成" 执行完commit后，想撤回commit，怎么办？这样凉拌：git reset --soft HEAD^ 这样就成功的撤销了你的commit注意，仅仅是撤回commit操作，您写的代码仍然保留。说一下个人理解：HEAD^的意思是上一个版本，也可以写成HEAD~1如果你进行了2次commit，想都撤回，可以使用HEAD~2 至于这几个参数：--mixed 意思是：不删除工作空间改动代码，撤...

git报错-Initial commit Untracked files nothing added to commit but untracked ……【图】

文章转自 https://www.jianshu.com/p/61c3db30d488在目标执行命令 git stratus 报错根据上面的文章，可以解决问题。不行的话，请留言。感谢你的阅读原文：https://www.cnblogs.com/pzkperson/p/11980213.html

在Git中如何撤销上一次的commit【代码】

有的时候我们一不小心就git commit -m ‘commit message info’解决办法，很简单，只需执行git reset HEAD~这条命令即可，即能保证你原本的修改还在，也能撤销本次提交失误。这种撤销上一次提交是比较好的，如果是版本回退的话也能解决这个问题，但是版本回退只适合于你本次提交并没有改动什么或者改动不大的情况。如果你改动太多，版本回退意味着着你需要重新复制一遍，当然了，解决这种问题的办法有很多，分支开发的方式也能解决...

Git关于pull,commit,push的总结【图】

文章转自：http://www.cnblogs.com/wnbahmbb/p/6568179.html以前总是由于自己的自身的原因，对于每一次的git的操作，我都是通过eclipse或者是idea来进行的，但是我每一次都不是很清楚的关于这些方面的操作，现在我们来进行关于git bash的操作，正是由于这些操作使的自己对于git的操作有了一个比较清晰的认知了，首先我们先看一张图:首先我们必须要先理解这几个概念:暂存区，本地仓库，远程仓库首先暂存区这个是我们每一次进行代码修...

[Practical Git] Clean up commits with git rebase【代码】

Sometimes its nice to clean up commits before merging them into your main code repo; in this lesson, we go over using git rebase to squash commits together and then rename the condensed commit message. We also talk about potential issues with rebasing and where to be careful. //First, you can fetch the remote branchgit fetch//Then can see the logs between remote branch and local branch git log ori...

git rev-parse介绍；获取commit id

git rev-parse master^{commit} 是什么意思显示master提交的SHA1值if you want to make sure that the output actually names an object in your object database and/or can be used as a specific type of object you require, you can add the ^{type} peeling operator to the parameter. For example, git rev-parse "$VAR^{commit}" will make sure $VAR names an existing object that is a commit-ish (i.e. a commit, or ...

Git合并特定commits 到另一个分支

经常被问到如何从一个分支合并特定的commits到另一个分支。有时候你需要这样做，只合并你需要的那些commits，不需要的commits就不合并进去了。合并某个分支上的单个commit首先，用git log或GitX工具查看一下你想选择哪些commits进行合并，例如：dd2e86 - 946992 -9143a9 - a6fd86 - 5a6057 [master] \ 76cada - 62ecb3 - b886a0 [feature]比如，feature 分支上的commit 62ecb3 非常重要，它含有一个bug的修改...

pre-commit钩子，代码质量检查：在 vue-cli 3.x 版本中，已经使用尤大改写的yorkie，yorkie实际是fork husky，然后做了一些定制化的改动，使得钩子能从package.json的 "gitHooks"属性中读取

出处：https://github.com/ZSI2017/blog/issues/14yorkie 的 github：https://github.com/yyx990803/yorkiepre-commit钩子，代码质量检查：在 vue-cli 3.x 版本中，已经使用尤大改写的yorkie，yorkie实际是fork husky，然后做了一些定制化的改动，使得钩子能从package.json的 "gitHooks"属性中读取原文：https://www.cnblogs.com/cag2050/p/10518074.html

git commit 相关遇到的问题

1、如果选取某个分支的某次commit。目前我在master的工作比较正常。在分支中完成了一些工作，因为commit的过程中引入了一次错误的commit。导致目前代码处于两个功能分支的代码不能合并于主线。解决方案：A 忽略错误继续开发，心态是目前这个项目只有我一个人。B:看pro git等书，找方案回头继续开发C:把两段代码复制下来，在添加一次覆盖commit，使得主线正确运行。暂时选C。之后回来处理B的问题。rebase等操作可能可以但是目前很多...

git log 显示与特定文件相关的 commit 信息【代码】

显示与特定文件相关的 commit 信息git log -- <file> 显示与特定文件相关的 commit 信息，并显示每个 commit 对该文件的修改git log -p -- <file> 显示与特定文件相关的 commit 信息，包括重命名等的情况git log --follow -p -- <file> 解决方案来源Git – Particular File Change History原文：https://www.cnblogs.com/sun-ye/p/14993492.html

Git拉取分支报错(fatal:‘XXX' is not a commit and a branch ‘XXX' cannot be created from it)【代码】

一、问题出现1.当远程仓库分支上有一个本地仓库没有的分支时2.本地使用git checkout命令检索这个远程分支git checkout -b 本地分支名远程分支名当出现上述情况时，就会出现报错：fatal:‘XXX‘ is not a commit and a branch ‘XXX‘ cannot be created from it二、问题原因远程新建的分支没有更新到本地。实际上，git仓库分为本地仓库和远程仓库，我们用checkout命令是从本地仓库中找要检出的分支的。本地仓库只有在进行网络请求...

git 删除错误提交的commit

转自：http://www.douban.com/note/189603387/正好遇到进阶问题。试了一下，是我要的，直接把服务器主版本还原了。不过这样也挺危险的，自己用用还可以。方法: git reset --hard <commit_id> git push origin HEAD --force其他: 根据–soft –mixed –hard，会对working tree和index和HEAD进行重置: git reset –mixed：此为默认方式，不带任何参数的git reset，即时这种方式，它回退到某个版本，只保留源码，回退com...

git undo last commit【代码】

$ git commit -m "Something terribly misguided" (1) $ git reset --soft HEAD~ (2) << edit files as necessary >> (3) $ git add ... (4) $ git commit -c ORIG_HEAD (5)转自： http://stackoverflow.com/questions/927358/how-do-you-undo-the-last-commit原...

git commit message规范与约束【代码】

Commitizen、Commitlint、Husky、Standard-version项目内安装和使用一、在项目的根目录下创建package.json文件 npm init --yes二、安装配置Commitizen命令安装 npm install -D commitizen npm install -D cz-conventional-changelog在package.json中配置 "script": {...,"commit": "git-cz",},"config": {"commitizen": {"path": "node_modules/cz-conventional-changelog"}} 配置完成之后就可以使用了，与全局安装时的命令git ...

git commit 后尚未push到远程，撤销commit

执行commit后，还没执行push时，想要撤销这次的commit，该怎么办？解决方案：使用命令：git reset --soft HEAD^这样就成功撤销了commit，如果想要连着add也撤销的话，--soft改为--hard（删除工作空间的改动代码）。命令详解：HEAD^ 表示上一个版本，即上一次的commit，也可以写成HEAD~1 如果进行两次的commit，想要都撤回，可以使用HEAD~2--soft 不删除工作空间的改动代码，撤销commit，不撤销git add file--hard 删除工作空间的...

GIT - 技术教程分类

Git 教程 Git 安装配置 Git 工作流程 Git 工作区、暂存区和版本库 Git 基本操作 Git 分支管理 Git 查看提交历史 Git 标签 Git Gitee Git 服务器搭建 git 全部

GIT - 最热教程

windows下使用GitBash命令工具执行pyth...手动搭建史上最高效最便宜的全自动图床...jenkins中通过git发版操作记录 CI/CD笔记-Jenkins与gitlab实现CICD GitLab最佳实践 -- 集成git-secrets扫描...linux 安装 gitlab 中文社区版以及汉化 GIT在Linux上的安装和使用简介，gitlin...使用git bash 执行Python中文乱码 Git分支合并冲突解决（续）git 获取远程分支的代码

首页 / GIT / 前端技巧：git commit提交规范

前端技巧：git commit提交规范

内容导读

内容图文

内容总结

内容备注

内容手机端

【前端技巧：git commit提交规范】教程文章相关的互联网学习教程文章

git reset commit

git报错-Initial commit Untracked files nothing added to commit but untracked ……【图】

在Git中如何撤销上一次的commit【代码】

Git关于pull,commit,push的总结【图】

[Practical Git] Clean up commits with git rebase【代码】

git rev-parse介绍；获取commit id

Git合并特定commits 到另一个分支

pre-commit钩子，代码质量检查：在 vue-cli 3.x 版本中，已经使用尤大改写的yorkie，yorkie实际是fork husky，然后做了一些定制化的改动，使得钩子能从package.json的 "gitHooks"属性中读取

git commit 相关遇到的问题

git log 显示与特定文件相关的 commit 信息【代码】

Git拉取分支报错(fatal:‘XXX' is not a commit and a branch ‘XXX' cannot be created from it)【代码】

git 删除错误提交的commit

git undo last commit【代码】

git commit message规范与约束【代码】

git commit 后尚未push到远程，撤销commit

GIT - 相关标签

GIT - 技术教程分类

GIT - 最新教程

GIT - 最热教程