Git提交规范

最新推荐文章于 2024-05-22 10:18:58 发布
最新推荐文章于 2024-05-22 10:18:58 发布
阅读量3.3k 收藏 2
点赞数 1
分类专栏： git学习
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39739342/article/details/108419399
版权

入职之后，发现自己之前git commit的格式过于随意，也觉得确实要好好重视这件事，此规范是 facebook 公司管理定义的提交规范。

注：并非说这规范就是标准，只是众多规范中我个人比较喜欢的

 

提交格式

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

// 空一行

<body>

各个标志意义即必要性：

type（必需）scope（可选）subject（必需）body(可选)

 

  1. type用于说明 commit 的类别

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

  3. subject是 commit 目的的简短描述，不超过50个字符。以动词开头，使用第一人称现在时，比如change，而不是changed或changes；第一个字母小写，结尾不加句号（.）

  4. Body 部分是对本次 commit 的详细描述，可以分成多行。

范例

fix: feat(0429留言下单): add 'graphiteWidth' option - 提交的具体情况

 

type 类型

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

注意点

  1. 是否可运行，每一个版本都应该是可运行的版本

  2. 选择性提交，commit Message需要详细写好每一个文件中更新了什么，多个不同功能的更改，尽量多次提交

  3. 如果更改较多，body中好好写清楚每一个文件做了什么改动

三猪
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Git提交说明规范
qq_40538274的博客
04-14 907
规范介绍 git commit信息格式介绍 type(scope): subject type(必须): commit 的类别，只允许使用下面几个标识： feat: 新的功能, fix: 修复Bug, docs: 只有文档变更, style: 空格, 分号等格式修复, refactor: 代码重构，注意和特性、修复区分开, perf: 提升性能, test: 添加测试, chore: 开发工具变动(构建、脚手架工具等), scope(可选)
Vue3 + TS4.8踩坑之配置husky问题env: sh\r: No such file or directory
yangxinxiang84的专栏
04-22 1809
mac下，保存husky的钩子命令文件commit-msg之后，git commit的时候提示：env: sh\r: No such file or directory。原因是.editorconfig配置中的end_of_line = crlf强制将文件转为了dos编码格式的。需要注释掉end_of_line = crlf，将commit-msg修改为unix编码的。
git: 关于commit的报错的问题
flying_chick的博客
02-18 2553
无
Git 提交规范
最新发布
come from h5
05-22 1484
团队协作，形成良好的代码提交规范。
git提交规范
litterboys的博客
03-23 8897
遵循 Git 提交规范可以让团队协作更加高效和规范，也更容易进行版本管理和代码维护。希望大家都能养成良好的提交习惯！
git commit 规范
Aurora_juan的博客
04-25 165
公司管理git提交规范，在此记录一波，😊 格式：type(scope): subject type有以下类型 type：用于说明commit的类别，规定为如下几种 1. feat：新增功能； 2. fix：修复bug； 3. docs：修改文档； 4. refactor：代码重构，未新增任何功能和修复任何bug； 5. build：改变构建流程，新增依赖库、工具等（例如webpack修改）； 6. style：仅仅修改了空格、缩进等，不改变代码逻辑； 7. perf：改善性能和体现的修改； 8. cho
Git commit 提交时报错: “subject may not be empty“ 或 “type may not be empty“
qq_41209915的博客
01-25 2642
是一个用于检查 Git commit message 是否符合指定格式的工具，它可以帮助团队保持一致的 commit 风格。使用 Git 提交代码时，commit message 没有满足 commitlint 的规则，导致提交失败。临时回退更改：如果你需要临时回退某个更改，可以使用以下模板。其他：对于一些无法明确分类的变更，你可以使用以下模板。提交信息改为如下格式。misc: 其他描述。
（004） git vue项目提交报错 subject may not be empty [subject-empty]
WGYHAPPY的博客
03-02 373
1.提交文件报错： 1.提交的时候，备注的信息要符合 commitlint.config.cjs 的规范：
Git提交规范结合实践
04-11
Git提交规范是软件开发团队协作中的重要组成部分，它有助于保持代码历史清晰，便于代码审查，回溯更改，以及自动化发布流程。以下是对标题和描述中所述知识点的详细说明： 1. **提交过程规范**： - **初始提交**：...
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
这个插件就是规范化git提交规范,让你的提交不仅"好看"还"实用" git 规范提交从何说起? git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了! 让我们看下Angular社区的提交规范 这个提交记录是不是...
git提交代码常用规范
12-30
git提交代码常用规范
git提交代码注释规范
01-12
git提交代码注释规范、git提交常用操作的规范指南、[A] 新增 ：(新加入的需求) [M] 修改 ：( 修改或者重构代码) [D] 删除 ：(删除多余的文件 ) [F] 修复 ：(修复bug)
git提交日志规范脚本.zip
07-15
项目由于git进行管控，对commit的日志需要进行规范化输出，git的hooks默认管控单仓库，在.git/hooks里面，默认关闭，如果启用的话将后缀.sample去掉。系统提供的commit检验是git文本的最后是否有空格，根据规定，...
关于解决IDEA中git的commit无效的解决方法
qq_46734518的博客
11-24 1万+
在开发中我们偶尔会遇到点击idea中commit无效的情况，点击完commit后，进度条一闪而过缺没有将代码提交上去。下面是本人总结的几种方法。
对git提交的简单理解
weixin_39006070的博客
09-01 1717
1.提交信息的格式 <type>(<scope>): <subject> // 空一行 <body> // 空一行 <footer> 其中，Header 是必需的，Body 和 Footer 可以省略。 不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。 1.1 Header 1.1.1 type type用于说明 commit 的类别，只允许使用下面7个标识。 ci: 更改我们的持续集成文件和脚本（
Git 约定式提交
qq_43082721的博客
12-24 918
概述 每次提交代码的时候，我们都需要为我们本次修改的内容添加一段描述，例如： git commit -m "Initial commit"; git commit -m "修复了一些已知问题。"; git commit -m "增加了新特性。"; 但实际上有些 commit message 千奇百怪，比如以下这种： 一次 commit 应该准确的说明本次提交的目的和修改内容，比如： git commit -m "chore: upgrade org.bouncycastle:bcprov-jdk15on
[git] git reset --hard后恢复操作
热门推荐
rifu19950726的博客
08-21 3万+
《转》Git 撤销commit的注意事项 http://www.cnblogs.com/scodong/p/4757378.html Git撤销commit的操作命令 git reset –hard HEAD^ 一、新建三个文件，demo1,demo2,demo3 二、git add 命令提交到暂存区，git reset HEAD demo1就是把提交到暂存区里的文件撤销。 上图...
git 提交中的commit 规范
weixin_46761843的博客
08-06 3444
最近又接受一个项目，上面的eslint各种规范真的是稍不注意就会出问题。也是在网上找了很多，感觉下面的总结很好的解决了我的困境。记录一下。方便下次查看。 一、为什么需要规范？ 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 这时候，有人提出了何不统一标准，大家都按照这个标准来。于是 ESLint，JSHint 等代码工.
怎么限制git提交规范
07-12
要限制Git提交规范，可以采取以下几个方法： 1. 使用Git钩子（Git hooks）：Git钩子是在特定Git事件发生时自动触发的脚本。你可以在本地或者远程仓库中设置Git钩子来验证提交信息的规范性。比如，在`pre-commit`钩子中可以编写脚本，检查提交的消息是否符合规范，如果不符合规范则阻止提交。 2. 使用Git提交模板（Git commit template）：你可以创建一个提交模板文件，定义提交信息的格式和规范，并将其配置为Git的默认提交模板。这样，在每次提交时，Git会自动打开该模板文件供你填写提交信息。你可以在模板文件中添加规范说明，以引导开发者按照规范填写信息。 3. 使用代码审查工具：一些代码审查工具（例如，Gerrit、Phabricator等）提供了对提交信息进行验证的功能。你可以配置这些工具来检查提交信息是否符合规范，并在不符合规范时拒绝合并。 4. 培训团队成员：进行团队内部的培训，提醒团队成员遵守提交规范，并说明为什么提交规范对于项目的质量和协作至关重要。 无论采取哪种方式，都应该明确规范的要求，并与团队成员进行充分的沟通和培训，以确保规范的有效实施。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值