分享下工作中使用的git提交规范

最新推荐文章于 2024-05-31 09:00:09 发布
最新推荐文章于 2024-05-31 09:00:09 发布
阅读量2.6w 收藏 89
点赞数 19
分类专栏： git版本管理
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/github_39506988/article/details/90298780
版权

git提交规范

遇到的问题
  1. 版本回退时无法快速定位到指定版本
  2. 无法知道项目中封版操作是哪一个commit
  3. 无法清晰的知道每次提交的记录
以下是commit提交规范

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。

其中，Header 是必需的，Body 和 Footer 可以省略。

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

Header部分只有一行，包括两个字段：type（必需）和subject（必需）。

type用于说明 commit 的类别，只允许使用下面9个标识。

feat: 新功能（feature）
fix: 修补bug
docs: 文档（documentation）
style: 格式（不影响代码运行的变动）
refactor: 重构（即不是新增功能，也不是修改bug的代码变动）
chore: 构建过程或辅助工具的变动
revert: 撤销，版本回退
perf: 性能优化
test：测试
improvement: 改进
build: 打包
ci: 持续集成

subject是 commit 目的的简短描述，不超过50个字符。

以动词开头，使用第一人称现在时，比如修改/修复/增加 等等
example: 订单详情增加导出功能
scope

scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

Body

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

xxx/xxx.vue  修改内容
xxx/xxx.vue  修改内容
Footer

Footer 部分只用于两种情况。

  1. 不兼容变动

    如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: 项目webpack升级到4.0版本
xx插件替换成xx插件
  1. 关闭 bug/需求
closes 3056, 11231

Revert

还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

revert: feat(pencil): 回退当前版本667ec到 sssee2

#建议

​ 文档综合了，公司项目git管理的实际情况，在某一些规范上进行了轻微修改，在平时提交fix和feat时，一般使用简写

feat: 增加订单详情  closes xxxx (closes非必需)
fix: 修复xx情况下xx问题  closes xxxx (closes非必需)
docs: 修改md文件
style: 修改订单列表样式
refactor: 重构utils.js下部分方法
chore: 增加xxx插件/xxxxloader
revert: 回退当前版本667ec到 sssee2
perf: 优化了xxx，提高了渲染速度
test：增加测试
improvement: 改进
build: 打包
ci: 持续集成

在某些复杂commit比如 revert，chore 等操作时最好在body，footer，描述清楚 遇到了什么问题，为何要这样做

revert: feat(订单模块): 回退当前版本667ec到 sssee2

因为某次提交失误，造成xxx问题
xxx.vue
xxx.js

closes xxx

chore(项目组件, 项目构建): 增加公用组件库xxx和xxx公用一套组件

为了解决xx问题， 引入公用组件库，使用方式见xx.md文档
一号小白
关注
  • 19
    点赞
  • 踩
  • 89
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Git的使用规范流程总结
10-21
大家都明白在团队开发中，遵循一个合理、清晰的Git使用流程，是非常重要的。否则，每个人都提交一堆杂乱无章的commit，项目很快就会变得难以协调...所以这篇文章给大家分享了Git的使用规范流程，有需要的可以参考借鉴。
git-commit-style:git提交样式
04-09
Git提交样式是Git版本控制系统中一个重要的实践领域，它关乎代码库的历史记录整洁性和可读性。Git提交信息是开发者之间交流的一种方式，因此遵循一定的提交样式有助于保持团队的一致性和项目的可维护性。本文将深入...
Git提交规范 feat、fix等字段含义
qq_45721579的博客
02-26 2589
【代码】Git提交规范 feat、fix等字段含义。
git提交规范 fix,feat等字段含义
默的博客
11-29 3万+
以下是commit提交规范，主要是在提交代码时标识本次提交的属性。
git 代码提交规范，feat，fix，chore都是什么意思?
最新发布
chenyajundd的博客
05-31 1734
使用规范的提交消息可以让项目更加模块化、易于维护和理解，同时也便于自动化工具（如发布工具或 Changelog 生成器）解析和处理提交记录。通过编写符合规范的提交消息，可以让团队和协作者更好地理解项目的变更历史和版本控制，从而提高代码维护效率和质量。
常用git语法
yutingwu816的博客
02-17 317
刚开始接触使用git管理代码的时候对版本版本控制和协同开发都没什么概念有些命令行走过一次，但是没有理解整个流程，还是会经常出错。这里记录一下已经熟悉了的： 1.查看代码状态: git status 2.添加代码到缓存区：git add . (注意空格之后有一个"." ) 3.提交代码到本地仓库：git commit -m “feat: XXX” (填写对代码所做的更改，比如添加新功能等) 4.将代...
Git 提交描述规范
qq_47614329的博客
07-27 676
以上是Git提交描述中使用的一些字符，不同的项目可以根据需求自定义特定字符，但是要保证提交描述的易读性和一致性。例如 (): ，来使用这些字符。例如： feat(search): add new search function。
Git提交代码规范
LeonYang
07-25 641
Git提交代码规范
gitDes:只是我使用Git的自定义文档
05-10
在这个名为"gitDes:只是我使用Git的自定义文档"的资料中，我们可以看到作者分享了他们个人使用Git的一些技巧和经验，特别是关于如何将本地的`master`分支重命名为`main`的操作，这是Git在2020年6月的一项更新，旨在...
Git LFS是用于使用Git管理大型文件的命令行扩展和规范 这是3.3.0的Linux Intel 64位安装包
03-02
- **初始化项目**：在项目中首次使用Git LFS时，需要运行`git lfs init`来启用LFS。 - **跟踪文件类型**：使用`.gitattributes`文件指定哪些类型的文件应由LFS处理，例如`*.psd filter=lfs diff=lfs merge=lfs -text...
git:npm.zip_git
09-19
Git和npm的结合使用，使JavaScript项目的协作和维护变得更加高效和规范。通过Git进行版本控制，确保团队成员间的一致性，通过npm管理代码依赖，实现模块化开发，降低项目复杂度。对于初学者，掌握这些基础知识是迈向...
git或svn提交消息时，fix、feat等命令的含义
m0_71349739的博客
12-20 992
在git或svn提交消息时，可以使用特定字符来表示特定的功能，这些字符的使用可以提高提交描述的可读性和易用性。 具体来说，这些命令的含义如下：
[学习笔记] [git命令] 项目常用git命令详解
shmily_jing的博客
09-12 421
安装git sudo apt-get install git sudo apt-get install git-core sudo apt-get install gitk（图形化工具） Git属性配置 配置用户信息： git config --list git config --global user.name "yourname" git config --global use...
Git fetch和git pull的区别
热门推荐
Robin Hu的专栏
06-14 45万+
原文：http://www.tech126.com/git-fetch-pull/ Git中从远程的分支获取最新的版本到本地有这样2个命令：1.git fetch：相当于是从远程获取最新版本到本地，不会自动merge git fetch origin mastergit log -p master..origin/mastergit merge origin/maste...
git commit 提交规范 & 规范校验
BiuBiu_Tian(田)
06-06 7万+
1、背景 在多人协作项目中，如果代码风格统一、代码提交信息的说明准确，那么在后期协作以及Bug处理时会更加方便。 因此，在本文章中，我会介绍怎么使用下面这个工具，在git push 代码之前检测commit messages： commitlint husky commitlint介绍 2、先来介绍博主采用的commit规范 Commit message格式 &amp;lt;ty...
Git团队开发管理规范、GitFlow流程规范
爱是与世界平行
07-21 940
Git团队开发管理规范、GitFlow流程规范Git管理规范一、Git代码仓库创建规范1.1 代码仓库创建规范1.2 Groups使用规范1.3 目录结构及权限介绍1.4 README文件规范二、代码提交规范（*）2.1 commit三要素2..2 标题2.2.1 类型2.2.2 改动范围2.2.3 精简总结2.3 内容2.4 备注三、仓库代码规范（*） Git管理规范 一、Git代码仓库创建规范 1.1 代码仓库创建规范 项目创建需符合Group规范。 创建项目必须添加Project descri
git提交时忽略某些文件
07-09
领域的最新发展和趋势，并与学生分享相关信息。这包括新的语法特性、框架、工具等，让学生了解行业的最新动态。 3. 实用工具和资源：我会介绍一些实用的工具和资源，如开发环境、调试工具、在线学习平台等。这些工具和资源可以帮助学生更高效地学习和实践javascript。 4. 编码规范和最佳实践：除了基础知识，我也会教授学生编码规范和最佳实践。这包括代码风格、命名规范、性能优化等方面的内容，帮助学生养成良好的编码习惯。 5. 协作和团队合作：在教学过程中，我也会强调协作和团队合作的重要性。我会鼓励学生参与小组项目或合作开发，锻炼他们的团队合作能力和沟通技巧。 通过教授课本外的知识，我希望能够帮助学生获得更全面的学习体验，提升他们的职业竞争要在Git提交时忽略某些文件，你可以使用`.ignore`文件。下面是一些步骤忽略特力，并培养他们在实际工作中的成功能力。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值