Git commit格式参考

最新推荐文章于 2024-07-04 21:45:57 发布
最新推荐文章于 2024-07-04 21:45:57 发布
阅读量837 收藏 2
点赞数
分类专栏： Git 文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/noahsun1024/article/details/105037686
版权

前言

文章首发于Noah Sun’s Home Git commit格式参考，转载请注明出处，谢谢！

编写良好的Commit messages可以达到以下几个重要的目的

  • 加快review的流程
  • 帮助我们编写良好的版本发布日志
  • 让之后的维护者了解代码里出现特定变化和feature被添加的原因

目前，社区有多种 Commit message 的写法规范。来自Angular 规范是目前使用最广的写法，比较合理和系统化。如下图：
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-A2EGlMzg-1584887393563)(http://image.noahsun.top/git_commit_guidelines/angular_commit_example.jpg)]

Commit messages格式

当前业界应用的比较广泛的是 Angular Git Commit Guidelines

具体格式为:

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

每个commit message一般包含header、body和footer，header是必须的，body和footer不做强制要求，所以一般可以简化为

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

或者省略scope

<type>: <subject>

说明

  • type: 本次 commit 的类型，诸如 bugfix docs style 等
  • scope: 本次 commit 波及的范围
  • subject: 简明扼要的阐述下本次 commit 的主旨
  • body: 同样使用祈使句，在主体内容中我们需要把本次 commit 详细的描述一下，比如此次变更的动机
  • footer: 描述下与之关联的 issue 或 break change，详见案例

例子

feat(jqLite): add prop() support
fix(ngStyle): correctly remove old style when new style value is invalid
docs(developers): commit message format typo
style(animator): style cleanup
refactor(filter): filters are now injectable and services
perf(*): don't trigger digests after enter/leave of structural directives
test(mocks): test mocks with compiled angular
chore(release): preparing release notes for 0.10.3

Type

类型必须是以下其中一种

  • feat: 新功能
  • fix: bug fix
  • docs: 只改了文档
  • style: 代码格式修改，不影响代码的逻辑性，比如空格，格式化，缺失分号等
  • refactor: 代码重构，既不是bug fix也不是新功能
  • perf: 性能优化
  • test: 补充或修改测试代码
  • chore: 改变构建流程，或者增加依赖库和工具等，比如增加文档生成工具

Scope

范围可以是指定提交更改位置的任何内容，比如search, location, browser, compile等

你可以使用*来代替多个范围

Subject

主题包含对变更的简洁描述，有几个要求

  • 使用祈使句和现代时，比如使用change而不是changed或者changes
  • 首字母不要大写
  • 句末无需使用句号

Body

主体与主题一样，应使用祈使句和现代时，应包括改变的动机，并将其与以前的行为进行对比。

Footer

描述一些重大的修改和相关的问题，详情参考 AngularJS Message footer

Revert

当回滚提交时，必须以 revert: 作为开头然后紧跟着该提交的header。

body部分可以这样描述


This reverts commit <hash>.

hash是将要被回滚的那个提交的SHA码。

参考

您必须知道的 Git 分支开发规范
angular.js-git-commit-guidelines
AngularJS Git Commit Message Conventions

noahsun1024
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
git commit 规范指南
weixin_34375233的博客
04-13 842
前言 Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。 不过话说回来，作为最具个人创造力和最会利用工具的物种——程序猿，最好是能有规范和工具的约束。否者的话，你可能看到以下的commit message： 目前，社区...
Git Commit message 编写规范
yanglingchao的博客
04-21 1003
在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。上面代码的-m参数，就是用来指定 commit mesage 的。如果一行不够，可以只执行git commit，就会跳出文本编译器，让你写多行。git commit在我们开发中，直接在idea中装插件使用，其中必填为type和short description；
如何在项目中规范git commit格式
热门推荐
天心天地生的博客
08-13 4万+
一、为什么要规范化Commit message 格式化的Commit message，有几个好处。 （1）提供更多的历史信息，方便快速浏览。 比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的。 $ git log <last tag> HEAD --pretty=format:%s （2）可以过滤某些commit（比如文档改动），便于快速查找信息。 比如，下面的命令仅仅显示本次发布新增加的功能。 $ git log <l
常用的Git commit 提交规范！
最新发布
嵌入式大杂烩
07-04 562
在我们嵌入式开发中，版本管理工具Git已经成为不可或缺的一部分。Git帮助我们记录代码变更历史，提供了强大的代码协作开发功能。初学时，我们基本都是按照下面的格式这么来写commit信息的吧？甚至有些公司的commit信息也很随意也类似于上面这样的。这样的commit信息包含的信息比较有限，不利于后续的版本追溯。其实，为了确保团队成员能够更高效地协作，并且保持代码库的整洁和有序，需要团队各成员遵循达成一致的commit提交规范。
Git Commit的正确姿势
行云流水
09-26 1万+
Commit message 的格式每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。<type>(<scope>): <subject>// 空一行<body>// 空一行<footer> 其中，Header 是必需的，Body 和 Footer 可以省略。不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观
团队代码规范/格式化工具clang-format三git commit自动格式化代码
zmlovelx(帅得不敢出门 程序员群31843264)
03-30 5815
前置条件 假设已经安装有clang-format,及配置出了.clang-format配置文件 .clang-format放在源码项目中的最上层目录 创建git hook 目的是在git 中commit时，自动格式化提交改变的文件 git管理的项目中新建 .git/hooks/pre-commit #!/bin/bash STYLE=$(git config --get hooks.clangf...
【git系列】git-commit含义用法选项示例详解
wang2leee的博客
02-08 2984
【git系列】git-commit含义用法选项示例详解
Git Commit格式校验
大灰狼的小绵羊哥哥的博客
04-27 3161
Git 规范 Git 作为现在最流行的分布式管理工具，基本上是每个团队的必备。 Git Commit格式校验 准备commitlint/cli用于格式校验 准备husky用于git提交代码时触发校验 husky husky 是创建 git 客户端 hooks 的神器。 目前最新版本是 7.*，文档在这里(opens new window) 初始化 husky 只需要三步。首先要安装： $ npm i husky --save-dev 复制代码 执行下面的脚本，会初始化一个 .husky
一文教你如何设置git commit模板规范
皮皮不调皮的博客
04-11 5284
别再乱提交代码了，一文如何设置git commit模板规范？
提升Git提交效率与规范：Format & Faster Your Git Commit项目解读
gitblog_00044的博客
06-09 880
提升Git提交效率与规范：Format & Faster Your Git Commit项目解读 项目地址:https://gitcode.com/devpolo/gac 在日常的软件开发流程中，Git作为版本控制工具的地位无可动摇，而高效的Git提交习惯对于团队协作至关重要。今天，我们来深入探讨一款旨在优化和加速Git提交过程的开源神器——Format and Faster Your G...
git commit 常规提交格式案例
仨仨的博客
03-21 2万+
我们将以几个常见的案例了解git commit 常规提交格式。
4. git规范 - commit格式
Var_YanGuangYing
12-10 694
Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。 type 用于说明 commit 的类别，只允许使用下面7个标识。 feat：新功能（feature） fix：修补bug docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变动） test：增加测试 chore：构建过程或辅助工具的变动 ...
Git commit type 规范
CalledJoker的博客
01-06 2224
git commit 提交规范 提交规范： git commit -m “feat(新增暂停功能): 新增执行推广任务暂停功能” 详情请参考：阮雪峰的Commit message 规范(点击可转跳) (https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html) # 主要type feat: 增加新功能 fix: 修复bug # 特殊type docs: 只改动了文档相关的内容 style:
Git commit emoji 表情常用项整理
缘自天方的博客
09-15 1154
emoji emoji 代码 commit 说明 ????(庆祝) :tada: 初次提交 ????(全新) :new: 引入新功能 ????(书签) :bookmark: 发行/版本标签 ????(bug) :bug: 修复 bug ????(急救车) :ambulance: 重要补丁 ????(地球) :globe_with_meridians: 国际化与本地化 ????(口红) :li
Git Commit 规范
暮年雨影的博客
08-31 378
Git Commit 规范
提交信息规范
weixin_33751566的博客
12-17 381
commit message格式说明commit message一般包括三部分：Header、Body和Footer。 Headertype(scope):subject type：用于说明commit的类别，规定为如下几种 feat：新增功能；fix：修复bug；docs：修改文档；refactor：代码重构，未新增任何功能和修复任何bug；build：改变构建流程，新增依赖库、工具等（例如...
Git commit添加默认消息模板
kabcko的博客
06-19 2535
git config --global commit.template <模版文件路径(例如:xx/xx/template.txt)> git config --global core.editor vim(配置vim当编辑器) 参考： 是时候规范一下我们的git commit了 Git配置全局Commit模版和编辑器 ...
Git提交信息格式
朱工的专栏
11-23 5232
什么情况需要提交 每当完成了一个新功能、修复了一个错误、重构一个模块或者调整格式时，都应该提交一次代码，以便版本工具记录这次修改。 规定：不能将不相关的修改一块提交，混合不同的功能会使得以后的问题查找或者其他成员浏览历史变得困难。 提交信息格式 <type>: <subject> //空一行 <body> type：用于说明本次提交的类别，规定为以下几种： feat：新功能 fix：修复错误 refactor：重构代码 style：调整代码格式（不影响代码运行
git commit 模板设置
宋大人专栏
07-07 2万+
git config –global commit.template /Users/tao/.template_git（绝对路径）
git commit用法
09-06
git commit 是用于将更改保存到版本控制系统（如 Git）中的命令。它记录了代码库的某个特定状态，并生成一个唯一的标识符（commit ID）。这个标识符可以用来在需要的时候查找和恢复特定的代码版本。 下面是 git commit 的一般用法： 1. 首先，确保你在正确的代码库目录下。可以使用 `cd` 命令进入正确的目录。 2. 运行 `git status` 命令，查看当前代码库的状态。这会显示哪些文件已被修改、添加或删除。 3. 如果有修改或新增的文件，可以使用 `git add` 命令将它们添加到暂存区域。例如，`git add file1.txt` 或 `git add .`（添加所有文件）。 4. 运行 `git commit` 命令来创建一个提交。例如，`git commit -m "Added feature XYZ"`。这里的 `-m` 参数用于指定提交的简短描述。 5. Git 会为每个提交生成一个唯一的 commit ID。你可以使用 `git log` 命令查看提交历史记录，包括每个提交的 ID、作者、日期和描述等信息。 除了基本用法外，还有其他参数和选项可用于更高级的操作，例如修改先前的提交、编辑提交消息等。你可以参考 Git 的文档或其他资源来了解更多详细信息。 希望这能回答你的问题！如果你还有其他疑问，请随时提问。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值