规范git的提交信息

最新推荐文章于 2025-10-11 13:44:32 发布

原创最新推荐文章于 2025-10-11 13:44:32 发布 · 621 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#git

git 专栏收录该内容

1 篇文章

订阅专栏

本文介绍了一种规范化的提交信息格式，包括类型、范围、主题、正文和脚注等部分，并提供了常见类型的示例。

之前在项目中写commit message比较随意，每次改完代码都随手写了个fix，后来也因此吃了个亏，所以痛下决心改了这个不好的习惯。看了看目前使用比较广泛的Angular的规范。决定以后将commit message修改如下。

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

<body>

<footer>

type:

feat：    新功能（feature）
fix：     修补bug
docs：    文档（documentation）
style：   格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：    增加测试
chore：   构建过程或辅助工具的变动

scope

scope用于说明 commit 的修改范围，比如列出修改的文件什么的。

subject

subject是 commit 目的的简短描述

body

本次 commit 的详细描述，可以分成多行。每行不宜太多内容，防止自动换行。

footer

针对某个issue，可以在 footer 部分关闭这个 issue 。Closes #243

一般情况下，为了便于查看提交信息，头部一定要这么写<type>(<scope>): <subject>。

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

鱿刃有鱼

关注关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

工程化：Commitlint / 规范化Git提交消息格式

我的乌托

05-19

721

规范化的提交消息不仅能使版本历史清晰，还能提高代码审查和自动化工具的效率。Commitlint 是一种工具，用于确保Git提交消息符合预定义的格式规范。本文将详细介绍Commitlint的安装、配置及使用方法，帮助开发团队实现提交消息的规范化。Commitlint通过验证Git提交消息格式，帮助开发团队实现提交消息的规范化。通过安装和配置Commitlint及Husky，可以在每次提交时自动验证提交消息，确保团队的提交规范一致性。为了在每次提交时自动验证提交消息，可以使用Husky进行Git钩子管理。

git commit 提交规范

青颜的天空的博客

03-21

4381

约定式提交规范是一种基于提交消息的轻量级约定。它提供了一组用于创建清晰的提交历史的简单规则；这使得编写基于规范的自动化工具变得更容易。这个约定与 SemVer 相吻合，在提交信息中描述新特性、bug 修复和破坏性变更。提交说明的结构如下所示： <类型>[可选的作用域]: <描述> [可选的正文] [可选的脚注] 大致分为三个部分(使用空行分割): 标题行: 必填, 描述主要修改类型和内容主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等页脚注

参与评论您还未登录，请先登录后发表或查看评论

详细的Git 代码提交规范

最新发布

念旧的博客

10-11

1570

Git提交规范指南：核心在于通过标准化的提交信息（类型+描述）形成清晰的项目历史。常用类型包括feat（新功能）、fix（bug修复）、docs（文档更新）等，提交信息包含标题、正文和页脚三部分。标题格式为"类型(范围):描述"，使用祈使句；正文说明修改原因；页脚标注重大变更或关联Issue。建议保持原子性提交，使用工具辅助规范，并与工作流结合。实际应用中可简化格式，按团队需求调整规范。

git 提交规范化（webpack）

讨口子

11-03

400

/ 可选类型types: [{ value: 'feat', name: 'feat: 新功能' },{ value: 'fix', name: 'fix: 修复' },{ value: 'docs', name: 'docs: 文档变更' },{ value: 'style', name: 'style: 代码格式(不影响代码运行的变动)' },{name: 'refactor: 重构(既不是增加feature，也不是修复bug)'},

git提交规范

qq_27271817的博客

11-12

572

克隆项目： git clone git@YourIp:ProjectName.git 拉取提交过程(主分支拉到本地开发)： git pull git@YourIp:ProjectName.git develop:develop （必须是第一步） git checkout -b JIRA_NAME develop （本地开发分支名称）编写并修改代码，

【Git 】规范 Git 提交信息的工具 Commitizen

day day up

07-05

1512

Commitizen是一个用于规范Git提交信息的工具，它旨在帮助开发者生成符合一定规范和风格的提交信息，从而提高代码维护的效率，便于追踪和定位问题。以下是对Commitizen的详细介绍。

Git 提交信息书写规范

qq_39194983的博客

06-29

1380

Git 提交信息书写规范

Git提交规范

Rsun2018的博客

01-09

1212

revert:”开头，后跟要恢复到的那个提交的标题。然后在消息正文中，应该写上“This reverts commit ”，其中“”是要还原的那个提交的SHA值。正文是对标题的补充，但它不是必须的。和标题一样，它也要求使用祈使句且现在时态，正文应该包含更详细的信息，如代码修改的动机，与修改前的代码对比等。compile、$rootScope、ngHref、ngClick、ngView等，唯一需要注意的是它必须足够简短。代码回滚比较特殊，如果本次提交是为了恢复到之前的某个提交，那提交消息应该以。

git-commit-lint-vscode:vscode一款git 规范化提交插件

05-17

这个插件就是规范化git提交规范,让你的提交不仅"好看"还"实用" git 规范提交从何说起? git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了! 让我们看下Angular社区的提交规范这个提交记录是不是...

git 提交信息规范文档

10-28

本文档所阐述的Git提交信息规范，是为了让开发者在提交代码时能够提供更清晰、一致的信息，从而提高工作效率和代码质量。首先，规范的提交信息可以提供更多的历史信息，使项目历史更加清晰。一个好的提交信息可以...

Git 提交规范

come from h5

05-22

7400

团队协作，形成良好的代码提交规范。

Git提交信息规范

Rex的博客

09-01

4697

git提交规范

编写良好的 git 提交信息

增阅笔记

11-19

2866

编写一个良好的 git 提交信息提交信息我们作一次提交，都会提交相关的修改信息，一般这些信息当时都会仔细考虑留下应该留下的那些重要信息，比如为什么需要这次提交，提交解决什么问题等。而且我们需要好好组织这些信息，一边以后查看，因为这些跟代码一样重要，他们是历史，就像课本一样，一旦留下错误的信息或者难以理解的信息，将会对后来者，产生非常多的麻烦。提交信息规范一般来说，提交信息没

git 提交信息规范

08-16

在使用Git提交代码时，我们应该遵循规范的提交信息格式，以便让其他人更好地理解这次代码提交的目的和内容。通常，我们可以使用一些工具来约束开发者编写符合规范的提交说明。一个常用的工具是Commitizen，它可以帮助我们生成符合规范的提交信息。为了使用Commitizen，我们首先需要在项目中安装cz-conventional-changelog包，并将其配置为Git提交时的默认工具。具体操作是在项目的package.json文件中添加以下内容： ``` "scripts": { "cm": "git-cz" }, "config": { "commitizen": { "path": "./node_modules/cz-conventional-changelog" } } ``` 然后，在我们提交代码时，可以使用以下命令替代"git commit"： ``` npm run cm ``` 这样，Commitizen就会弹出一个交互式的界面，要求我们填写符合规范的提交信息。通过这种方式，我们可以更好地规范我们的提交信息，提高代码审查、信息查找和版本回退的效率和可靠性。123 #### 引用[.reference_title] - *1* *2* *3* [Git 提交规范](https://blog.youkuaiyun.com/fd2025/article/details/124543690)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT3_1"}}] [.reference_item style="max-width: 100%"] [ .reference_list ]