git commit message 格式规范

最新推荐文章于 2024-04-12 05:47:06 发布
最新推荐文章于 2024-04-12 05:47:06 发布
阅读量1.2k 收藏
点赞数 1
分类专栏： git 文章标签： git commit message 格式 提交规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tang_yi_/article/details/108860208
版权

  在工作中，我们肯定会与git打交道。那么当你提交代码后如何让别人很快了解到你此次提交代码的改动点是哪些。此时就需要一个提交信息来描述此次提交修改的内容。没有格式的提交信息，会使提交记录杂乱无章，不能很快的定位哪些提交涉及代码修改，哪些只是配置修改等等。而好的提交信息能使提交历史更容易阅读，找到你想要的信息。这篇文章将整理 Angular 代码仓库制定的提交规范。

  在该格式中，提交消息由三部分构成 header，body，footer。

  <header>
  <BLANK LINE>
  <body>
  <BLANK LINE>
  <footer>

在日常工作中我们一般只用 header，body 与 footer 一般不会用，但是当你需要提 PR 到别人库时会被要求写这两部分。以下是各部分职责以及格式。

header 格式

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: common|core|packaging|service|page|component|config
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|style|test|deps

其中， type 和 short summary 是必须要有的，scope 为可选字段。

type 类型

  type 用于标记此次提交的类型。

  • feat：新增功能
  • fix：bug修复
  • docs：文档相关改动
  • style：对代码的格式化改动，代码逻辑并未产生任何变化
  • refactor：重构代码或者其他优化举措，理论上不影响现有功能
  • perf：提升性能
  • test：新增或者修改测试用例
  • build：项目工程化方面的改动，代码逻辑并未产生任何变化。（包括但不限于文档，代码生成等）
  • ci：CI配置文件和脚本的更改
  • deps：升级依赖

scope

  scope 用于标记此次修改文件的范围。这个范围可以对应某个功能或者文件夹都可以。

short summary

  short summary 用于描述此次提交的内容，应言简意赅。

  • 使用祈使句、现在时：如应该使用 change 而不是 changed 或者 changes
  • 不要大写第一个字母
  • 句末没有句号

body

  补充 short summary，适当增加原因，目的等相关因素，用于说明更改的动机。也可以将此次提交与现有功能（或代码）比较说明更改的影响。

footer

  footer 可以包含一些重大的更改信息，比如非兼容性修改之类的信息需要在此描述清楚。也可以引用相关的 issue，或者其他 PR 等。

🌰

如 Angular 代码库的 PR 记录：https://github.com/angular/angular/pulls

传送门：
Angular Commit Message Format (https://github.com/angular/angular/blob/master/CONTRIBUTING.md)

安和-
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Git commit 消息的格式与约定式提交
成富的专栏
06-09 1450
在开发人员的日常工作中，提交代码到 Git 是必不可少的动作。代码提交时的消息该怎么写呢？最基本的原则是：如果团队有 commit 格式要求，就遵循该要求。这一点与代码风格是一样的。commit 消息的格式没有绝对的好与坏，最重要的是保持一致性。如果团队没有具体的格式要求，可以参考下面的一些建议。消息应该分成主题和内容两个部分，两部分用一个空行分隔。主题部分对 commi...
idea git commit插件
03-24
idea commit 模板插件
git commit规范梳理
YouZi_X的博客
08-14 767
commit message格式 <type>(<scope>): <subject> type(必须) 用于说明git commit的类别，只允许使用下面的标识。 feat：新功能（feature）。 fix/to：修复bug，可以是QA发现的BUG，也可以是研发自己发现的BUG。 fix：产生diff并自动修复此问题。适合于一次提交直接修复问题 to：只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix docs：文档（docu
Git Commit Message Format
Wisimer
04-27 560
Never leave todays’s work tomorrow. 1. Why need format It will benefit ourselves and others. 2. Specific format Let’s first see the abstract formula: <type>(<scope>): <subject> e...
Git Commit Message规范
qq_25775675的博客
10-13 1970
Git commit message规范是一种良好的实践，可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。
Git commit格式参考
noahsun1024的博客
03-22 833
前言 文章首发于Noah Sun’s Home Git commit格式参考，转载请注明出处，谢谢！ 编写良好的Commit messages可以达到以下几个重要的目的 加快review的流程 帮助我们编写良好的版本发布日志 让之后的维护者了解代码里出现特定变化和feature被添加的原因 目前，社区有多种 Commit message 的写法规范。来自Angular 规范是目前使用最广的写法...
leetcode2-git-commit-message-helper:一个帮助git代码提交规范的JetBrains系列插件，支持IDEA、
06-29
git-commit-message-helper 本插件是源idea插件的升级版，增加了一系列个性化配置。 安装 直接从 IDE 插件管理器安装（文件 > 设置 > 插件 > 浏览器存储库 > Git Commit Message Helper） 用法 如果要更改提交类型，...
How to Write a Git Commit Message
04-25
一篇非常不错的关于提交GIT message的英文文章
vscode-git-commit
04-10
VSCode git commit是一个VSCode扩展，用于创建带有表情符号和前缀的精美提交消息。 那是第一个版本：P 如何使用它 ？ 使用ctrl+alt+enter （在Mac上为cmd+shift+enter ）或click SouceControl中的图标 设定值 1....
GitEmoji- emoji for git commit message-crx插件
04-02
语言:English (United States) 表情符号的git commit消息 提交消息的表情符号指南。 它只是https://gitmoji.carloscuesta.me/的Chrome扩展版本
Git commit格式 详解
热门推荐
u013803262的专栏
03-18 1万+
我们在使用git进行版本控制的时候,commit的格式是有要求的。我们可以先去看一些顶级项目他们的commit的格式是怎样的。angular在github上的commit信息 我们可以发现 commit都有一些前缀,比如说 feat test chore fix refactor docs现在我们来讲解git commit信息的格式Commit Message 格式<type
提交信息规范
weixin_33751566的博客
12-17 377
commit message格式说明commit message一般包括三部分：Header、Body和Footer。 Headertype(scope):subject type：用于说明commit的类别，规定为如下几种 feat：新增功能；fix：修复bug；docs：修改文档；refactor：代码重构，未新增任何功能和修复任何bug；build：改变构建流程，新增依赖库、工具等（例如...
4. git规范 - commit格式
Var_YanGuangYing
12-10 686
Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。 type 用于说明 commit 的类别，只允许使用下面7个标识。 feat：新功能（feature） fix：修补bug docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变动） test：增加测试 chore：构建过程或辅助工具的变动 ...
git commit 规范
yanzi_0216的博客
11-19 1250
git commit 规范目的commit message格式type(必须)scope(可选)subject(必须)git hooks 转载自 https://zhuanlan.zhihu.com/p/182553920 mark 一下，方便查看 目的 git commit 规范的主要目的是为了规范化 commit 格式，使每次的 commit 清晰指明本次提交的目的、备注信息以及影响范围。 commit message格式 <type>(<scope>): <subje
【知识整理】Git Commit Message 规范_git commit msg 规则
最新发布
2401_84183492的博客
04-12 1127
外链图片转存中…(img-VKZ2Dmto-1712871950994)]
git commit规范
weixin_51474815的博客
01-23 7753
如何规范git commit提交 github是我们用于协同开发的平台，方便开发人员协同开发，极大提高了开发效率，但是经过团队第一次协同开发后，我们发现了一个很大的问题，我们的git commit非常不规范，至于在开发后期项目出现bug之后，很难找到问题所在，为了规范以后的开发，学习使用commitizen,husky以及standard-version来规返回git commit提交，并且自动化生成CHANGLOG commitizen commitizen是用来制定git commit规范的工具 首先让
github配置SSH key值（附：git commit Message规范格式）
wjh-yalta的博客
09-27 565
github配置SSH key值 生成SSH key 在git命令行中输入命令 : ssh-keygen -t rsa -c "邮箱地址" 一直回车即可。最后生成两个文件，如下图 github上添加SSH key 在github上点击“setting”，找到添加SSH key的菜单，然后新增SSH key；把文件id_rsa.pub 里面的内容全部复制到 key编辑框中，保存完毕； 检查S...
Git Commit message 规范
Wiliam的博客
02-07 5059
Git Commit message 规范介绍格式HeaderBodyFooterRevert常用示例featfixdocsstylerefactorperftestchorerevert参考链接 介绍 在 Git 中，每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。这个操作将通过 git commit 完成。 git commit -m "芜湖~起飞" 上面代码的-m参数，就是用来指定 commit message 的。 如果一行不够，可以只执行 git commit
git commit message 规范
06-06
Git commit message规范是指Git版本控制系统中提交代码时，对于commit message的书写规范化。这样可以让每个commit message都更加清晰明确，便于开发者和其他项目成员理解和维护代码。常见的规范包括commit message...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值