【科普】Git Commit Guidelines

最新推荐文章于 2023-01-17 10:49:08 发布
最新推荐文章于 2023-01-17 10:49:08 发布
阅读量170 收藏
点赞数
分类专栏： DevOps
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42343595/article/details/111415322
版权
本文介绍了为何要遵循Git提交消息规范，以Angular规范为例，详细阐述了Header、Body和Footer的构成，并提及了如何利用Commitizen、Commitlint+Husky和Standard Version等工具确保提交消息的格式和质量。此外，还分享了在项目中实施这些规范的方法。
摘要由CSDN通过智能技术生成

为什么需要

  • 降低Review成本，可以明确知道本次提交的改变和影响
  • 规范整个Team的提交习惯，对技术素养的养成有益
  • 可以通过统一工具，抽取规范的message自动形成change log

git-commit-1.png

GitHub Angular Demo

目前Github的Angular项目，就是完全采用规范的Git Message来进行日常的提交管理和发布管理的，下面是这个项目的Commit记录，和自动根据commit生成的change log
git-commit-2.png

遵循什么规范

目前，使用较多的是AngularJS规范

# 包括三个部分：Header，Body 和 Footer
 
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

Header

包括三个字段：type（必需）、scope（可选）和subject（必需）

任何一行都不能超过100个字符

type

用于说明 commit 的类别，类型包含如下几种

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
最低0.47元/天 解锁文章
天行者YANG
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Git Commit emoji Guide
Wollens Blogs
03-01 700
Git Commit emoji Guide 背景 gitmoji 是一个标准化和解释在 GitHub 提交消息上使用 emoji 的提议，gitmoji 是一个开源项目，专门规定了在 ``github 提交代码是应当遵循的 emoji 规范。在 git commit上使用 emoji 提供了一种简单的方法，仅通过查看所使用的表情符号来确定提交的目的或意图 概述 在执行 git commit 指令时使用 emoji 图标为本次提交一个特别的图标，这个本次提交的记录很容易突出重点，也可以光看图标就知道本次提交
git-commit-style-guide：使git commit消息更易读和有用
02-03
git-commit-style-guide 目的 统一团队Git commit日志标准，可以进行后续代码审查，版本发布以及日志自动化生成等等。 统一团队的Git工作流，包括分支使用，标签规范，问题等 Git commit日志参考案例 总体方案 Git提交日志基本规范 <type>(<scope>): <subject> <BLANK> <body> <BLANK> <footer> 所有的类型类型如下： 类型代表某人次提交的类型，某种是修复一个错误还是增加一个新的功能。 壮举：新增功能 修复：修复错误 docs：仅仅修改了文档，例如README，CHANGELOG，CONTRIBUTE等 样式：仅修改了空格，格式缩进，逗号等等，不改变代码逻辑 重构：代码重构，没有加新功能或修复bug perf：优化相关，有助于提升性能，体验 测试：测试用例，包括单元测试，集成测试等 琐事：改变重建流程，或者增加依赖库，工具等 恢复：回滚到上一个版本 格式要求： # 标题行：50个字符以内，描述主要变更内容 # # 主体内容：更详细的说明文本，建议72个字符以内。 需要描述
Git Commit Guidelines(指南)
itas109的专栏
05-01 439
Git Commit Guidelines(指南)
Git commit message guidelines
yangjingxu的专栏
03-02 133
https://github.com/hpcc-systems/HPCC-Platform/wiki/Git-commit-message-guidelines
【Git】Git Commit Guidelines
YzzHA 的博客
06-02 234
Git Commit Guidelines Git 提交应当书写 commit message, 开源社区最广泛的则是 Angular Git Commit Guidelines 规范 Angular 规范要求的 commit message 格式如下 <type>(<scope>): <subject> Header 包括三个字段：type(必需)、scope(可选)和subject(必需) Type feat : 新功能 fix : bug 修复 .
idea git commit插件
03-24
idea commit 模板插件
git的commit模板及commit规范校验工具一键安装
08-12
使用方式： 1、解压package.rar package.rar 2、进入package文件夹，右键打开git bash 3、执行 sh install.sh 进行...4、执行git init 命令，查看当前目录是否生成 .git/gitcommit 和 .git/hooks/commit-msg 验证
commit-msg-linter:git commit消息linter钩子
05-03
欢迎来到git-commit-msg-linter :waving_hand: :eyes: 立即查看您的每条git commit消息 :rocket: 。 一个git“ commit-msg”挂钩，用于根据流行的来替换您的git commit消息。 作为一个挂钩，它将在每次提交时运行...
gitlog:从 git commit 消息管理更改日志
06-14
从 git commit 消息管理更改日志 命令 有2个可执行命令： bin/控制台 gitlog:branch [path_to_repo] 显示 repo 的分支。 bin/控制台 gitlog:commit [path_to_repo] 显示或导出日志。 该命令支持以下参数： --...
COMMIT MESSAGE GUIDELINE参考规范
sunshinezjb的博客
03-20 163
- [Angular的代码提交说明规范](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) - [conventional-changelog-cli](https://github.com/conventional-changelog/conventional-...
使用 husky 进行Git提交前的代码校验和 commit msg检查
热门推荐
huangpb的博客
10-22 3万+
husky 是一个 GitHook 工具。本文主要实现提交前 eslint 校验和 commit 信息的规范校验。 1. 安装 husky，lint-staged，@commitlint/cli，@commitlint/config-conventional 依赖 lint-staged: 用于实现每次提交只检查本次提交所修改的文件。 npm i -D husky lint-staged.........
scope may not be empty [scope-empty]
qq_33051709的博客
04-03 2762
git commit 提价报这个错 ✖ scope may not be empty [scope-empty] git commit -am 'feat: 提交内容' 这个错误很明显了，没有添加范围，应为用到了lerna 管理父子项目 加上范围就可以了 git commit -am 'feat(modeA): 提交内容' 最后根据这个地址找到了答案 ...
前端工程化之commit规范（代码提交规范）
11-17 1087
其实规范不管是前端还是后端也好，我觉得吧，在任何的工程化的项目中都是不可或缺的部分啦，commit 提交不规范，项目维护和管理起来是极其麻烦的，毕竟每个人都具有自己的个性，commit message的格式也是参差不齐git 可以帮我们很好地管理代码，但是在多人合作的时候，经常会碰到各种随意的 commit message，当你需要会看 commit message 的时候，就会很头疼。幸运的是我们可以使用工具去处理掉这个问题，不让这种小问题影响到项目的进展。
git学习总结之commit分类
万少博-FE
05-08 606
最新更新时间：2021年05月08日15:24:18 《猛戳-查看我的博客地图-总有你意想不到的惊喜》 本文内容：git commit命令的信息分类 commit分类如下 feat (A new feature) 新功能 fix (A bug fix) 漏洞修复 docs (Documentation only changes) readme或者项目文档修改 style (Changes that do not affect the meaning of the code (w
git 规范
sky527759的博客
03-17 449
分支模型 分支说明 master 分支 主分支，永远处于稳定状态，对应当前线上版本 不允许在该分支直接提交代码，只能提交pull request master 回滚时，按版本回滚 bitbucket上应设置相关的分支保护策略（禁止重写历史，禁止deleted，禁止没有pull request的修改） beta 分支 预发布分支，发布前先将分支合并入beta，进行自动化测试，部署前检查等。 协作人数少于3时，可不使用beta分支 不允许在该分支直接提交代码，只能提交pull request
前端代码规范最佳实践
ppppppppppsd的专栏
01-17 348
Why 团队开发中，每个人的编码习惯不同，代码格式不同。这就会导致代码难看，难以维护。统一代码风格可以： 增强代码的可读性，降低维护成本有利于代码审查养成规范代码的习惯，有利于自身成长 How 推荐使用 eslint + prettier 来进行代码格式化。 通过 git hook 调用来实现代码的自动格式化，git hooks 工具推荐 husky。 既然用到了 git hook，顺便把提交信息规范也做一下，这里推荐 commitlint。 用到的插件 eslint: js/jsx 语法检查插件 按照
git commit 模板设置
宋大人专栏
07-07 2万+
git config –global commit.template /Users/tao/.template_git（绝对路径）
Git 笔记 - git commit
Yuki_yuhan的博客
10-25 7932
git commit 常用命令：选项 -m ，使用给定 msg 作为提交消息；选项 -a，修改文件后不需要执行 git add 命令，直接就能提交，新建文件除外；选项 -p，使用交互式界面来选择要提交的更改，让用户有机会在将修改后的内容提交前查看差异；选项 -C，获取现有提交对象 commitId ，并在创建提交时重用日志消息、作者信息、时间戳；选项 -c，与 -C类似；选项 -n，这个选项可以绕过 pre-commit 和 commit-msg ；选项 --amend，创建新提交来替换当前分支的提交信息；
git commit -m和git commit 区别
最新发布
05-31
`git commit -m` 和 `git commit` 的区别在于提交代码时是否添加提交信息。 `git commit -m` 命令用于将暂存区的修改提交到 Git 代码库中，并且可以添加一条提交信息，描述本次提交的内容。选项 `-m` 后跟着的字符串就是提交信息的内容。例如： ``` $ git add . $ git commit -m "add a new feature" ``` 这个命令将当前目录下所有修改添加到暂存区，然后提交暂存区的修改到 Git 代码库中，并添加了一条提交信息，描述本次提交的内容为“add a new feature”。 而 `git commit` 命令则会打开默认编辑器，供用户输入提交信息。例如： ``` $ git add . $ git commit ``` 这个命令将当前目录下所有修改添加到暂存区，然后打开默认编辑器，供用户输入提交信息。 因此，`git commit -m` 更适用于提交简短的修改，而 `git commit` 更适用于需要添加详细提交信息的情况。不过，无论使用哪种方式提交代码，都应该添加有意义的提交信息，以便自己和其他开发者能够快速了解本次提交的内容。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值