git commit 提交规范

最新推荐文章于 2024-06-05 23:52:54 发布
最新推荐文章于 2024-06-05 23:52:54 发布
阅读量400 收藏
点赞数
文章标签： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/q411020382/article/details/102921453
版权

更多文章

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

大致分为三个部分(使用空行分割):

  1. 标题行: 必填, 描述主要修改类型和内容
  2. 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等
  3. 页脚注释: 放 Breaking Changes 或 Closed Issues
type: commit 的类型
  • init: 初始化
  • feat: 新功能
  • fix: 修改问题
  • refactor: 代码重构
  • docs: 文档修改
  • style: 代码格式修改, 注意不是 css 修改
  • test: 测试用例修改
  • build: 构建项目
  • chore: 其他修改, 比如依赖管理
scope: commit 影响的范围, 比如: route, component, utils, build…
subject: commit 的概述
body: commit 具体修改内容, 可以分为多行.
footer: 一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接.

示例

fix（修复BUG）

如果修复的这个BUG只影响当前修改的文件，可不加范围。如果影响的范围比较大，要加上范围描述。

例如这次 BUG 修复影响到全局，可以加个 global。如果影响的是某个目录或某个功能，可以加上该目录的路径，或者对应的功能名称。

// 示例1
fix(global):修复checkbox不能复选的问题
// 示例2 下面圆括号里的 common 为通用管理的名称
fix(common): 修复字体过小的BUG，将通用管理下所有页面的默认字体大小修改为 14px
// 示例3
fix: value.length -> values.length
feat（添加新功能或新页面）
feat: 添加网站主页静态页面

这是一个示例，假设对点检任务静态页面进行了一些描述。
 
这里是备注，可以是放BUG链接或者一些重要性的东西。
chore（其他修改）

chore 的中文翻译为日常事务、例行工作，顾名思义，即不在其他 commit 类型中的修改，都可以用 chore 表示。

chore: 将表格中的查看详情改为详情

其他类型的 commit 和上面三个示例差不多，在此不再叙述。

谭光志
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
git提交代码注释规范
01-12
git提交代码注释规范、git提交常用操作的规范指南、[A] 新增 ：(新加入的需求) [M] 修改 ：( 修改或者重构代码) [D] 删除 ：(删除多余的文件 ) [F] 修复 ：(修复bug)
git commit规范提交
酒无忧的博客
11-06 529
Git每次提交代码时，都要写Commit Message（提交说明），通常情况下，Commit Message应该清晰明了，说明本次提交的目的和具体操作等。例如，有些人会写此次代码的修改是基于哪个模块，有些人会写解决了哪些Bug，有些则只写修改了哪个文件，中英文混用等等五花八门的Commit格式，这导致后续的代码维护成本很高，有时候提交人看Commit Message都不知道自己改了什么。比如查阅某个业务的修改历史，查阅某个时间段修复了哪些Bug，因为Commit没有统一的格式，就比较难快速获取这些信息。
Git commit规范
最新发布
qq_34738754的博客
06-05 421
表示此次commit涉及的文件范围，可以使用。描述此次commit涉及的修改内容。来表示涉及多个范围。
git commit 代码提交规范
辰风沐阳
08-08 2194
每个人 git 的提交记录都有自己的风格和习惯，特别是多人协作开发的项目，如果没有一套完整的规范，则每个人的代码提交描述内容会很随意，质量参差不齐，会降低 log 的可读性和维护性。所以，需要有一套 git 提交规范，使得提交记录清晰明了，让人一看就能知道每次提交的目的。本文记录一种业界比较认可和常用的规范，来自 AngularJS 团队规范。...
Git commit注释规范
刘贤松的博客
03-30 563
* type用于说明 commit 的类别，只允许使用下面8个标识。 * br: 此项特别针对bug号，用于向测试反馈bug列表的bug修改情况 * feat：新功能（feature） feat：功能描述 [taskId] * fix：修补bug * docs：文档（documentation） * style： 格式（不影响代码运行的变动） * refactor：重构（即不是新增功能，也不是修改bug的代码变动） * test：增加测试 * chore：构建过程或辅助工具的变动 *
【Git】Git commit 注释规范
南方有乔木的博客
05-21 1018
【Git】Git commit 注释规范 1 前言 规范的注释方便自己进行合并、撤消、回退。当代码有几十个分支，有成千上万条提交时，你随时可能面临着合并分支，回退代码，舍弃代码，对比代码，复制历史记录中有用的代码片段等等。如果仅靠千篇一律的注释，是很难从快速从注释中提取有用的信息，并且会遇到选择困难，不知道要合并哪个点，不知道要回退到哪里等。而传统的tag是用来记录大版本号，或发布时使用的。 2 注释格式 [标签]：[注释内容] 标签的作用是快速识别和判断出当前提交的内容的...
git commit提交信息修改
01-20
1. **`git commit` 命令**: 当你对代码进行了修改并希望保存这些更改时，通常会使用 `git add` 添加到暂存区，然后通过 `git commit` 创建一个新的提交。提交信息应该清晰、简洁且遵循一定的规范，例如Angular的...
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写提交信息作为改动说明,保存 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 验证
Git Commit 规范1
08-03
Git Commit 规范是软件开发过程中非常重要的一个环节，它有助于保持代码库的整洁和历史记录的可读性。在Git中，一个良好的Commit消息能够清晰地表达每次提交的目的和内容，使得团队成员能快速理解代码变更，这对于...
git提交日志规范脚本.zip
07-15
项目由于git进行管控，对commit的日志需要进行规范化输出，git的hooks默认管控单仓库，在.git/hooks里面，默认关闭，如果启用的话将后缀.sample去掉。系统提供的commit检验是git文本的最后是否有空格，根据规定，...
git提交代码常用规范
12-30
git提交代码常用规范
Git commit --amend 修改提交信息操作
10-14
主要介绍了Git commit --amend 修改提交信息操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
如何规范Git提交注释
信天翁的博客
09-05 2177
如何规范Git提交注释Git提交注释的构成Git提交注释的7个好规则Separate subject from body with a blank line / 使用空行分割主题与内容Limit the subject line to 50 characters / 主题行限制为50个字符Capitalize the subject line / 主题行首字母大写Do not end the subject line with a period/ 主题行行尾不添加句号Use the imperative
git提交代码注释信息规范
weixin_43623808的博客
11-18 2527
git commit -m “本次提交注释信息规范” JIRA-1234 feat: support for async execution ^-------^ ^--^: ^-------------------------^ | | | | | +--> Summary in present tense. | | | +--> Type: feat, fix, docs, style, refactor, pe
Git提交规范流程和解决冲突实际使用
chongchu7503的博客
07-10 837
前言：GIT对于我们程序员来说是吃饭的工具，本篇主要是针对提交和分支以及对于大多数程序员闻风丧胆的冲突一些个人见解，如果有啥不对的或者你们公司git提交流程欢迎下方评论。 在讨论规范之前，我们需要定最基本的要求 1.团队内保持良好的代码格式便于易读和维护，最主要减少不必要的代码冲突（建议统...
【GIT】Commit message 和 Change log 编写指南
小鱼菜鸟的博客
12-20 360
转自：http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html 作者： 阮一峰 Git 每次提交代码，都要写 Commit message(提交说明)，否则就不允许提交。 $ git commit -m "hello world" 上面代码的-m参数...
Git commit 规范
路漫漫其修远兮，吾将上下而求索！
07-26 2666
在多人协作项目中，良好的 commit 风格如下所示 这里使用的工具是 commitlint。 1 Commitlint message 的格式 Commitlint 基于 Angular 的规范。很多工具也是基于此规范, 它的 message 格式如下: // Header &lt;type&gt;(scope): &lt;subject&gt; // 空一行 Body // 空一行...
git commit正确写法
Shaun's blog
04-21 1245
哈哈哈
如何查看git 中的git commit 提交规范
07-28
回答: 要查看git中的git commit提交规范，可以执行以下命令: 1. 使用`git add .`将所有修改添加到暂存区。 2. 使用`git cz`或者`npm run commit`执行提交命令。 3. 如果想要限制提交内容按照规范来，可以使用commitlint。首先安装commitlint相关的依赖，可以执行`npm i -D commitlint @commitlint/config-conventional @commitlint/cli`。 4. 然后，commitlint会帮助我们限制git提交时的信息，如果提交的信息不符合指定的规范，会直接拒绝提交。 #### 引用[.reference_title] - *1* *2* *3* [Git Commit 提交规范](https://blog.csdn.net/win7583362/article/details/123176104)[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^v91^insertT0,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值