GIT 提交说明的规范

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

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

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

部分提交代码说明参考

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

Commit Message 的标准格式

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

[Issues][Module]<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

Header 介绍

Header 的组成:Issues、Module、type、scope、subject

① Issues(可选)

Issues 我们可以理解成我们平时的 需求单 或者 修改单 的单号,一般指的是社区使用人员提出的问题编号

② Module(可选)

当前的修改主要修改了项目中的哪个模块,此处的定义不是很严格

③ type(必须)

用于说明此次提交主要做了哪种类型的处理,主要有以下这些类型

type说明
feat增加了新功能或者新的需求(A new feautre)
fix修复了 bug 或者问题(fix a bug)
improvement对当前功能的改进(An improvement to current feature)
docs对文档进行了修改或者增加
style格式化的变动,不影响代码的逻辑
refactor对当前的需求的实现方式进行重构,不影响期望的结果
perf提高性能的修改
test增加或修改测试用例
build构建工具或外部依赖包的修改,比如更新依赖包的版本等
ci持续集成的配置文件或脚本的修改
chore杂项,其他不修改源代码或测试代码的修改
revert撤销某次提交

④ scope(可选)

此次提交的代码影响的范围,比如数据层、控制层、视图层等等

⑤ subject(必须)

此次提交的简短的描述

Body 介绍

Body:可以省略

Body 是对 subject 的补充,可以多行

Footer 介绍

Footer:可以省略

主要是一些关联 issue 的操作

提交示例

示例一:完成新的需求,需求单号为 208757,该需求可以让用户的积分推送到 kafka 的主题中

[208757][point][feat]: push customer's point to kafka

示例二:修改一个 bug,该 bug 产生在需求单 208756 中,对应的缺陷是 237405,该 bug 导致了部分数据丢失

[208756][user][fix]: fix bug which can make user's data lost

when user choose add address,some data will lost

#237405

或者

[208756][user][fix]: fix bug which can make user's data lost (#237405)
阅读终点,创作起航,您可以撰写心得或摘录文章要点写篇博文。去创作
  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
在使用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就会弹出一个交互式的界面,要求我们填写符合规范提交信息。通过这种方式,我们可以更好地规范我们的提交信息,提高代码审查、信息查找和版本回退的效率和可靠性。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* *3* [Git 提交规范](https://blog.csdn.net/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 ]

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

半吊子Kyle

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值