git commit 提交说明规范

git 提交说明规范:

图片版:
image



文字版:
提交格式如下:
--------------------- 格式start -----------------------

<type>[scope]: <subject>
空一行
[可选的正文 body]
空一行
[可选的页脚 footer]

---------------------- 格式end-----------------------
<> :尖括号,必须要写
[] : 方括号,可选填,不必须


1.type

类型 描述
feat 新功能feature
fix 修复bug
docs 文档注释
style 代码格式,不影响代码运行的变动
refactor 重构、优化(既不增加新功能也不修复bug)
perf 性能优化
test 增加测试
chore 构建过程或者辅助工具的变动
revert 回退
build 打包
ci 与ci 持续集成有关的改动
temp 临时代码,不计入 CHANGELOG,比如必须部署到某种环境才能测试的变更。如测试真机上

2.scope:
scope也是必填项,用于描述改动范围,格式一般为 项目名/模块名 例如:
node-pc/common
如果一次commit修改多个模块,建议拆分为多次commit,以便更好的追踪和维护。


3.subject:
填写简单的提交说明,言简意赅,不超过50字,可以清晰明了的指出修改的意图。


4.body:
选填,用于填写更详细的描述。主要描述改动之前的情况和修改动机,对于小的修改可以没有,但是重大需求、更新等必须添加body来作说明。


5.footer:
选填,用填写关联的issus,或者BREAK CHANGE.
必须是大写,表示引入了破坏性 API 变更,通常是一个大版本的改动,BREAKING CHANGE: 之后必须提供描述,下面一个包含破坏性变更的提交示例:


6.feat:
allow provided config object to extend other configs

BREAKING CHANGE:extendskey in config file is now used for extending other config files


参考:
https://blog.csdn.net/weixin_43957384/article/details/129450648
https://www.jianshu.com/p/7863bd84cae8


posted @   悟透  阅读(1597)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 全程不用写代码,我用AI程序员写了一个飞机大战
· DeepSeek 开源周回顾「GitHub 热点速览」
· 记一次.NET内存居高不下排查解决与启示
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布:重大改进与新特性概览!
点击右上角即可分享
微信分享提示