Git提交代码时怎么写规范信息

阿雪同学_6849

阿雪同学_6849

2026-10-14

393人浏览

原创

feat和fix分别表示新增功能与修复bug,须按“type(scope): 动词开头的简短描述”格式书写,scope应具体明确,subject需精准说明行为变更且不超过50字符。

git提交代码时怎么写规范信息

直接写 feat 或 fix 开头,后面跟括号注明模块、冒号、空格、动词开头的简短描述——这是最稳妥的起点,90% 的日常提交按这个格式就能被工具识别、被同事快速理解。

feat 和 fix 到底怎么选

选 feat 还是 fix,不看改动“多不多”,而看是否引入了新能力或修正了异常行为:

  • feat:用户能感知的新功能,比如登录页加了微信扫码入口、API 新增了分页参数
  • fix:修复了本不该出现的问题,比如点击按钮没反应、金额计算为负数、接口返回 500
  • 别用 fix 描述“改得更顺手”或“看着不舒服”的调整;这类属于 refactor 或 style
  • 如果改了一堆文件但本质就一件事(比如统一替换某个过时 SDK),仍用一个 feat 或 fix,别拆成多个提交

scope 括号里填什么才不白写

scope 不是装饰,它决定你以后能不能用 git log --grep="user" 快速筛出所有用户模块变更。填错等于没填:

每天工作结束后,一键生成当日所有 Git 仓库的提交日报,支持多仓库扫描
每天工作结束后,一键生成当日所有 Git 仓库的提交日报,支持多仓库扫描

Git 提交日报助手,自动扫描当天(含次日凌晨6点前)所有仓库的 commit,生成结构化日报。

下载
  • 优先填具体模块名:feat(auth)、fix(payment)、docs(api)
  • 避免泛化词:feat(frontend)、fix(server) —— 太宽,失去定位价值
  • 如果影响跨模块(比如改了公共工具函数),填 utils 或 shared,别写 all 或留空
  • 不确定 scope 时,先看项目已有提交里同类改动怎么写的,保持一致比“绝对正确”更重要

subject 描述为什么总被写成废话

“修复 bug”“新增功能”“优化代码”——这类描述等于没写。真正有用的 subject 要让读者一眼知道“改了什么行为”:

  • ✅ fix(cart): prevent duplicate item addition on rapid click
  • ✅ feat(search): support fuzzy matching for product names
  • ❌ fix: bug fix(信息密度为 0)
  • ❌ feat: new search feature(没说新在哪)
  • 动词必须是祈使式(add / support / prevent / remove),不是过去式(added / supported)
  • 长度控制在 50 字符内,超了说明没提炼核心

最容易被忽略的是:一个提交只做一件事,且这件事必须能被 type + scope + subject 三者共同锁定。AI 助手或新手常把样式调整、逻辑修复、依赖升级塞进同一个 commit,结果 git revert 时进退两难——这不是规范问题,是工作流设计缺陷。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

git提交代码 git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

2023.07.05

6059

9

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2023.07.06

1780

6

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

2023.07.24

1034

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

3957

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

3681

6

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

2026.10.10

100

15

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

2026.10.10

40

15

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

20

15

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

2026.10.10

40

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.9万人学习