你的 Git 提交是不是也一团糟 ？

已于 2024-03-22 12:26:27 修改
阅读量424 收藏 3
点赞数 4
文章标签： git 前端 后端 java javascript
于 2024-03-20 21:28:01 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/YopenLang/article/details/136343603
版权

大家好，我是楷鹏。

写一份干净的 Git Commit，不仅赏心悦目，也有诸多好处，比如

  1. 为项目或者仓库生成 change log
  2. 方便在其他一些 Git 工具使用，比如 CI/CD、代码协作和审计平台、发版工具等

但现实是，大家对 Git Commit 基本上是为所欲为，导致一团糟：

而这是 AngularJS 仓库的 Git Commit，干净，简洁，统一：

↪️ https://github.com/angular/angular/commits/main

AngularJS 对 Git Commit 做了规范，值得借鉴。

Commit 组成：

<header>
<空一行>
<body>
<空一行>
<footer>

🌰 举例：


对应如下：

其中

  • header 是必要的
  • body 也是必要的，除了类型为 docs 之外，body 的内容必须大于 20 个字符
  • footer 是可选的，比如放置引用的 issue

header 由三部分组成：

<类型>(<作用域>): <主题>
  │       │        │
  │       │        └─⫸ 简短总结，现在时态，不需要首字母大写，末尾不用加句号
  │       │
  │       └─⫸ Commit 作用域: animations|bazel|benchpress|common|compiler|compiler-cli|core|
  │                          elements|forms|http|language-service|localize|platform-browser|
  │                          platform-browser-dynamic|platform-server|router|service-worker|
  │                          upgrade|zone.js|packaging|changelog|docs-infra|migrations|
  │                          devtools
  │
  └─⫸ Commit 类型: build|ci|docs|feat|fix|perf|refactor|test

类型一共有 8 种：

类型描述
build影响构建系统或外部依赖的更改 (示例范围：gulp, broccoli, npm)
ci对 CI 配置文件和脚本的更改 (示例：CircleCi, SauceLabs, GitHub Workflow)
docs仅文档更改
feat新功能
fix错误修复
perf改善性能的代码更改
refactor既不修复错误也不添加功能的代码更改
test添加缺失测试或更正现有测试

作用域根据工程团队自己定义，可参考 AngularJS 定义的作用域列表：

↪️ https://github.com/angular/angular/blob/main/CONTRIBUTING.md#scope

主题要简单总结，如果团队使用英语，语法上需符合：

  • 祈使句，并且是现在时态，比如 “change”，而不是 “changed” 或者 “changes”
  • 首字母不需要大写
  • 结尾不需要逗号或者句号

🌰 举例

docs(server): add javadoc comments on methods

feat(core): add new command 'Upload' to UI

fix: update GET headers (#142)

Reference

https://medium.com/@menuka/writing-meaningful-git-commit-messages-a62756b65c81

One more thing：

{
  "公众号": "程序员楷鹏",
  "简介": "世界有 10 种人，一种是懂二进制的，另外一种是不懂的",
  "还有": "你肯定会关注的对吧彦祖？"
}
楷鹏 : )
关注
  • 4
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Git天天用但是Git原理你了解吗？
03-01
首先我们先从Git存储目录说起，通过gitinit创建一个空的Git仓库，具体操作如下图：创建完成后进入.git目录，如下图所示：hooks该目录用于配置客户端执提交操作用于触发服务端的脚本配置，一般用于自动化部署使用info...
Git提交日志修改方法实例汇总
01-09
git会打开$EDITOR编辑器，它会加载这次提交的日志，这样我们就可以在上面编辑，编辑后保存即完成此次的修改。 情况二：最后一次提交且已push到服务器 执行以下命令： git commit –amend git push origin master ...
如何规范你的GIT提交？
Leon的博客
03-04 169
一、为什么需要规范？ 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 这时候，有人提出了何不统一标准，大家都按照这个标准来。于是 ESLint，JSHint 等代码工具如雨后春笋般涌现，成为...
Git 提交规范-Java程序员收藏必备
weixin_40599844的博客
05-21 778
你可能会忽略的 Git 提交规范 规范是建立在程序开发者与程序阅读者一个沟通的桥梁，是一个团队必须要严格遵守的约定 ——动力节点Java学院 一、为什么需要规范？ 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 这时候，...
git 命令行忽略提交_你可能会忽略的 Git 提交规范
weixin_39623082的博客
01-14 182
一、为什么需要规范？无规矩不成方圆，编程也一样。如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。这时候，有人提出了何不统一标准，大家都按照这个标准来。于是 ESLint，JSHint 等代码工具如雨后春笋般涌现，成为了项目构建的必备良品。Git Com...
Git系列——Git 提交规范
格局、视野、认知
12-01 606
一直是 ESLint 的忠实用户，深知规范的重要性。然而，在新项目交接中，我被 Git Commit 规范逼疯了。才意识到自己的疏忽，于是便有了一探究竟的想法。 一、为什么需要规范？ 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维...
Git 提交规范
leone的博客
08-19 4150
git 提交规范 前言 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 提交规则 一个commit只做一件事情，若一个commit做了多件事情需要拆分成多个commit 严格遵循commit mess...
千万不要忽略的 Git 提交规范 !
林中静月下仙的博客
10-20 309
看完文章，你还会如此放荡不羁吗？你还会随心所欲的编写 Commit 吗？你还会如此 git commit -m “hello jartto” 提交吗？答案是否定的，因为使用了钩子函数，你没有机会了，否则将是无穷无尽的恢复 Commit。这倒可以养成良好的提交习惯。
git 提交中的commit 规范
weixin_46761843的博客
08-06 3406
最近又接受一个项目，上面的eslint各种规范真的是稍不注意就会出问题。也是在网上找了很多，感觉下面的总结很好的解决了我的困境。记录一下。方便下次查看。 一、为什么需要规范？ 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 这时候，有人提出了何不统一标准，大家都按照这个标准来。于是 ESLint，JSHint 等代码工.
Git 很难么？带你从头到尾捋一遍，不信你学不会！
民工哥的博客
03-10 1799
点击关注公众号，回复“1024”获取2TB学习资源！对于Git，相信大多数程序员并不会感到陌生。但是运用自如可不是一日之功，这可不，上次面阿里，就卡在了对 Git的各种理论理解与实际应用上...
你可能会忽略的 Git 提交规范
岁月安然
03-15 143
来源：Jartto's blog jartto.wang/2018/07/08/git-commit/ 一、为什么需要规范？ 无规矩不成方圆，编程也一样。 如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。 这时候，有人提出了何不统一标准，大家...
git提交数据教程
11-01
团队开发常用的git工具教程，这里提供的是上传文件教程的其中之一。
git提交信息模板
02-04
git提交信息模板 git提交信息模板 git提交信息模板 git提交信息模板
vue input 限制输入，小数点后保留两位 以及 图片垂直居中显示 和 分享 git 小技巧
呵呵哒!的博客
06-11 1095
error:Your local changes to the following files would be overwritten by merge:_error: your local changes to the following files w-CSDN博客。情况二：当本地的已经乱了，但是远端的master已经合并了你最后一次的代码，此时你可以先把你本地修改的文件先拷贝一份出来，然后让远端的master的代码强行覆盖掉当前的目录内容。
【Git】Windows下使用可视化工具Sourcetree
qq_45306739的博客
06-10 373
登录码云Gitee.com，在右上角我的主页–个人设置–安全设置–SSH公钥，将刚才的内容添加进去，输入密码检查后则会添加成功，该计算机本地则与云端仓库建立关联。首先安装Git，然后将本地和远端仓库建立联系，无论是Windows还是Linux下的工具只是将Git命令可视化。之前文章介绍过Linux系统中的Git工具：git cola。跳过Install的登录，直接一路安装，选择安装Git。如果第一次链接出现警告，输入yes验证后即可成功。用记事本打开id_rsa.pub，复制所有内容。
GStreamer编译安装——使用Meson从源代码编译
FREEDOM_X的专栏
06-12 1048
对于希望处理GStreamer代码本身和/或修改它的开发人员，或者希望快速尝试尚未在GStreamer正式版本中的功能的应用程序开发人员，这是推荐的设置。在mono存储库合并不同的GStreamer模块之前 单独的git存储库，并且有一个单独的meta-builder项目 调用。命令，您可以将构建目录指定为 参数。如果您想针对即将到来的开发或稳定的分支进行构建或开发 您应该使用包含mono的GStreamer模块的。， 可用于构建特定的GStreamer版本或构建未发布的版本 GStreamer代码。
hugo-magic主题使用教程(一)
最新发布
u010066597的博客
06-16 236
打开浏览器,输入地址: http://localhost:1313/拷贝hugo-magic主题核心文件到根目录 quickstart。在桌面右键打开Git bash运行以下命令。
git下载项目登录账号或密码填写错误不弹出登录框
weixin_43397326的博客
06-12 214
git下载项目登录账号或密码填写错误不弹出登录框
如何用 git 提交到远程仓库？
03-26
1. 首先，在本地仓库中使用 git add 命令将需要提交的文件添加到暂存区中。 2. 接着，使用 git commit 命令提交更改到本地仓库。 3. 确认本地仓库中的更改已提交后，使用 git push 命令将本地仓库中的更改推送到远程仓库。 具体步骤如下： 1. 打开终端或命令行工具。 2. 使用 cd 命令进入到本地仓库的目录。 3. 使用 git add 命令将需要提交的文件添加到暂存区，例如： git add file1.txt file2.txt 说明：可使用 "." 来添加所有文件。 4. 使用 git commit 命令提交更改到本地仓库，例如： git commit -m "add files" 说明：-m 参数中的 "add files" 是对本次提交的说明，可以根据需要修改。 5. 确认本地仓库中的更改已提交后，使用 git push 命令将本地仓库中的更改推送到远程仓库，例如： git push origin master 说明：origin 是远程仓库的别名（可以使用 git remote add 命令添加），master 是分支名，可以根据需要修改。 6. 如果是首次推送，可能需要输入用户名和密码。 7. 等待推送完成，检查远程仓库是否已更新。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值