GIT 提交说明的规范

最新推荐文章于 2025-11-21 03:58:11 发布
原创 最新推荐文章于 2025-11-21 03:58:11 发布 · 2.5k 阅读 · 5 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#git

本文介绍了GIT提交说明的规范，包括Header、Body和Footer的构成，详细阐述了各部分的作用，如feat表示新增功能，fix表示修复bug。遵循这套规范，能提高团队成员阅读PullRequest的效率。示例中展示了如何根据规范撰写提交信息。

GIT 提交说明的规范

通过 GIT 提交代码的时候，必须要写提交说明，否则就无法提交

如果我们所有人能够按照一套规范去写提交说明（Commit Message），那我们阅读 Pull Request 的效率就会很高， 参考了 Github 上的开源项目及部分公司的提交规范，总结出以下规范。

规范是所有人默认的一套规定，并不是强制要求，以公司的规范为首要，如果有问题，请留言。。。

部分提交代码说明参考

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

Commit Message 的标准格式

Commit Message 的组成部分：Header、Body、Footer

[Issues][Module]
最低0.47元/天 解锁文章
半吊子Kyle
关注
VUE 3.0 源码 scripts/verifyCommit.js 文件 对git提交时输入的描述信息进行规范
roywang6的博客
12-18 858
文件路径：VUE 3.0 源码 scripts/verifyCommit.js 当我们在命令行敲下 git commit -m "描述信息" 提交代码时，此文件会被触发，关键的配置信息还是在 package.json 这个文件中，具体如下： "gitHooks": { "pre-commit": "ls-lint && lint-staged", "commit-msg": "node scripts/verifyCommit.js" }, 复制代码 知识点-1： 如
Git提交规范
Rsun2018的博客
01-09 1251
revert:”开头，后跟要恢复到的那个提交的标题。然后在消息正文中，应该写上“This reverts commit ”，其中“”是要还原的那个提交的SHA值。正文是对标题的补充，但它不是必须的。和标题一样，它也要求使用祈使句且现在时态，正文应该包含更详细的信息，如代码修改的动机，与修改前的代码对比等。compile、$rootScope、ngHref、ngClick、ngView等，唯一需要注意的是它必须足够简短。代码回滚比较特殊，如果本次提交是为了恢复到之前的某个提交，那提交消息应该以。
iOS如何上传代码到Github
文明的博客
01-06 6561
iOS如何上传代码到Github 很多iOS开发者想开源自己的代码或者demo，开源到Github是个不错的选择，那么如何上传我们的代码到Github，令所有人可以下载使用呢？这里我们的目的很明确，就是上传我们本地电脑里面的一份代码到Github，所以我们不讲git的初级和高级用法。 第一步、申请Github账号。https://github.com/ ，如果已经有Github账号，那么直接进入
git提交规范说明
xy_z_H的博客
05-19 1853
在使用GIT操作的时候，我们最好在一开始就养成一个良好的提交说明规范，这和我们初学编程时候使用的注释是同样的道理，能够让我们提交的更改更加清晰易理解，特别是在多人合作的情况下，如果没有一个好的提交规范，那很难让别人看懂自己更改了什么地方 一、提交格式 type （scope）: message 二、参数介绍： 1、type：指的代码的提交类型，不同的提交类型表示对应不同的代码改动，比如： feat：新功能的开发 fix：bug的修复 docs：文档格式的改动 style：代码格式改变 refactor：对已
Upterm代码审查终极指南：7步提交规范与PR描述模板
最新发布
gitblog_00945的博客
11-21 740
Upterm作为21世纪革命性的终端模拟器，其开源项目的代码审查流程对于保证代码质量和项目健康发展至关重要。本文将为你详细介绍Upterm项目的代码提交规范和PR描述模板，帮助你快速上手贡献代码。📝 ## 为什么代码审查如此重要？ 在Upterm这个基于Electron和TypeScript的现代化终端项目中，代码审查不仅能够确保功能实现的正确性，还能维护代码库的长期可维护性。通过规范的PR
Git 学习笔记——git 提交规范和 Github/Gitee 使用说明
un357951的博客
01-24 1670
我们以vscode项目进行介绍访问https://github.com/microsoft/vscode 即可看到如下的界面页面的左上角：Star所以尽量不要像朋友圈集赞一样要求身边朋友刷starFork：Fork操作实际上是创建一个仓库的副本，并将仓库的upstream指向原仓库小问题：为什么要fork呢？为什么不直接push呢？fork方便了多人协作Watch：Watch操作可以向你的邮箱中推送该仓库的推送信息提示：如果不是特别重要的项目，不要随意点Watch，否则很容易邮箱被轰炸。
Git提交规范及使用说明（简略笔记）
m0_64276053的博客
05-25 3846
一.Git提交规范 一次提交包含四个信息： commit message - 提交的内容相关描述 author & committer - 作者及提交者 changed files - 修改的文件 hash & parent - 提交内容的hash及在提交树上的位置 1.提交信息 一般包括<header><body><footer>三部分。 <header>是必须的，一般在50个字符之内，其结构为：（其中<scope>
Git 提交信息书写规范
qq_39194983的博客
06-29 1421
Git 提交信息书写规范
Git 提交消息规范：理解 fix、feature 等关键词的含义
Ven%的博客
10-17 1113
本文介绍了Git提交消息规范，重点解析fix和feat等核心关键词的含义与使用场景。提交消息应包含类型、描述和可选范围，采用特定格式以便自动化生成变更日志和版本号。文档还列举了docs、style等其他常用关键词，并提供了格式规范、最佳实践示例，以及它们与语义化版本的关联关系。最后推荐了Commitizen等工具支持，强调规范的提交消息对团队协作、项目维护的重要作用，建议团队在项目初期就建立并遵守相关规范。
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
这个插件就是规范化git提交规范,让你的提交不仅"好看"还"实用" git 规范提交从何说起? git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了! 让我们看下Angular社区的提交规范 这个提交记录是不是...
Git提交规范说明
w1404273025的博客
07-06 452
Git提交规范说明
规范 Git 提交说明
liangshanbo1215的博客
02-27 726
此外，不管是 Header 还是 Body，任何一行都不得超过 72 个字符（或 100 个字符），以避免自动换行影响美观。
git 提交声明
znhyXYG的博客
07-29 418
git使用
Git提交规范详解
一起coding，一起嗨。
01-04 3244
Git提交规范详解
Git提交说明规范
弄啥嘞的博客
12-14 382
git commit信息格式介绍 type(scope): subject 1.type(必须): commit 的类别，只允许使用下面几个标识： feat: 新的功能, fix: 修复Bug, docs: 只有文档变更, style: 空格, 分号等格式修复, refactor: 代码重构，注意和特性、修复区分开, perf: 提升性能, test: 添加测试, chore: 开发工具变动(构建、脚手架工具等), 2.scope(可选) :
git提交规则
weixin_33918357的博客
04-04 716
对于IT人员来说GitHub,相信大家都不陌生，本文主要讲解使用Git命令提交时的message规范。对于一个英文水平有限的IT人员在项目中很多时候使用git commit， message往往会写的不尽如人意，或者当你使用git log时往往不知道之前提交的是什么东西，修改了什么，这样对以后的查看很不友好。git 提交有一个成熟的工具（Commitizen），本文也将介绍使用（Commitize...
【Git教程】（三）提交详解 —— add、commit、status、stach命令的说明，提交散列值与历史，多次提交及忽略 ~
Technology changes the world of life
02-26 3652
项目的版本库通常驻留在其.git目录中。其中包含了以提交形式存储的项目历史。由于Git 是个分布式系统，所以同一个项目通常可能会有多个拥有不同历史的版本库。按照 Git 的设计，我们可以在必要时再将这些历史重新合并起来。提交(通常也被称为版本、修订或修改集): 通过commit命令可以创建一次提交， 一 次提交通常存储了项目的某种确定状态，其中包含了该项目中所有文件的情况。每次提交中都包含了与作者和提交日期相关的元数据。
git提交备注规范
08-21
### Git 提交信息编写规范 Git 提交信息的编写规范有助于提高代码审查效率、简化版本控制流程，并增强团队协作的透明度。一个良好的提交信息应当清晰、简洁，并能够准确反映本次提交的目的和内容。 #### 提交信息的基本结构 一个标准的 Git 提交信息通常包含以下三个主要部分： 1. **Header（头部）**：描述提交类型和简短说明，是必填项。提交类型通常使用一个动词加名词的格式，例如 `feat(auth)` 或 `fix(bug)`，以表明此次提交的目的。常见的提交类型包括： - `feat`：新增功能 - `fix`：修复 bug - `chore`：日常维护任务 - `docs`：文档更新 - `style`：代码格式调整（不影响逻辑） - `refactor`：重构代码（不改变外部行为） - `test`：增加或更新测试用例 - `perf`：性能优化 - `ci`：持续集成配置更新 - `build`：构建系统或依赖项更新 - `revert`：回滚更改 2. **Body（正文）**：详细说明修改内容（如动机、实现细节），是可选项。这部分可以用来解释为什么进行此次更改，以及更改是如何实现的。例如，描述某个 bug 的具体表现，或者新增功能的设计思路。 3. **Footer（页脚）**：关联 Issue、描述破坏性变更（BREAKING CHANGE）等，是可选项。如果此次更改影响了现有功能或接口，应当在此部分明确指出，并说明如何迁移或调整。 #### 提交信息书写规范 为了确保提交信息的一致性和可读性，建议遵循以下书写规范： - **使用英文书写**：尽管中文也可以使用，但英文是国际通用语言，便于跨团队协作。 - **第一行不超过 50 个字符**：保持简洁，避免过长的标题。 - **使用祈使句**：例如 `Fix bug in login flow` 而不是 `Fixed bug in login flow`。 - **空一行后写正文**：正文应详细说明更改的背景、原因和实现方式。 - **使用换行符**：每行不超过 72 个字符，以便在 Git 工具中更好地显示。 #### 示例 ```text feat(auth): add password strength meter Add a visual indicator for password strength during registration. This improves user experience by providing real-time feedback. Closes #1234 ``` ```text fix(login): handle empty input fields Ensure that the login form does not submit empty values. This prevents unnecessary API calls and improves validation. BREAKING CHANGE: Update form validation logic to require non-empty fields. ``` #### 工具支持 为了帮助开发者更方便地遵循提交规范，可以使用以下工具： - **Commitizen**：一个命令行工具，引导开发者按照规范填写提交信息。 - **Husky**：Git 钩子工具，可以在提交前自动校验提交信息是否符合规范。 - **VSCode 插件**：如 "Git Commit Message Editor"，提供图形界面辅助填写提交信息。 #### 配置示例 1. **安装 Commitizen 和 Husky** ```bash npm install -g commitizen npm install --save-dev husky ``` 2. **初始化 Commitizen** ```bash commitizen init cz-conventional-changelog --save-dev --save-exact ``` 3. **配置 Husky** 在 `package.json` 中添加以下内容： ```json { "husky": { "hooks": { "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" } } } ``` 4. **安装 Commitlint** ```bash npm install --save-dev @commitlint/config-conventional @commitlint/cli ``` 5. **创建 Commitlint 配置文件** 创建 `.commitlintrc.js` 文件： ```javascript module.exports = { extends: ['@commitlint/config-conventional'], }; ``` 通过以上配置，开发者在提交代码时将受到规范约束，确保每次提交的信息都符合标准。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值