找回密码
 立即注册
首页 业界区 业界 实际工作中 Git Commit 代码提交规范是什么样的? ...

实际工作中 Git Commit 代码提交规范是什么样的?

臧莞然 2025-6-2 23:52:19
前言

Git 是我们日常工作中使用最为广泛的分布式版本代码控制系统,因此在我们的实际工作中,git commit 代码提交规范能够让每一次代码提交都变得有据可循,方便后续的代码审查、问题追踪和版本管理。同时,规范的提交信息也能够为自动化工具提供便利,如生成变更日志、自动化部署等。
git commit 规范写法示例

首先我们一起来看看行业统一认可且标准的 angular 项目的 git commit 规范写法。

  • https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular
1.png

2.png

基本格式

首先一个规范的 git commit message 通常包含 Header、Body 和 Footer 三部分,各部分之间使用空行分隔。
  1. <header><br>// 空一行<br><body><br>// 空一行<br><footer><br>
复制代码
Header 必填

描述提交类型和简短说明。格式为:(): ((): )。

  • 类型(Type): 必填,指明本次提交的目的,如 feat 表示新开发的功能(feature)、fix 表示修复 bug、refactor 表示代码重构等。
  • 作用域(Scope): 可选,描述修改的影响范围,如模块名、功能名等,视项目不同而不同。
  • 主题(Subject): 必填,是 commit 简明扼要的提交描述。长度建议不超过 50 个字符。
  1. feat(payment): 微信支付功能集成<br>
复制代码
Body 可选

详细说明本次 commit 修改的内容。使用空行分隔段落,保持可读性。
  1. - 新增微信支付SDK依赖<br>- 实现支付结果回调处理<br>- 添加支付相关的单元测试<br>
复制代码
Footer 可选

主要用于关联 Issue、描述破坏性变更(BREAKING CHANGE)等。
  1. Closes #889<br>BREAKING CHANGE: 旧版支付回调接口已废弃,需迁移至 /api/v2/callback<br>
复制代码
实际工作常用的 git commit 规范写法

其实在实际开发工作中很多时候我们主要关注和使用的是 git commit message 的 Header 部分。Header 通常包含了提交的类型、作用域和简短的主题描述,这些信息对于快速了解每次提交的内容和目的已经足够。
描述提交类型和简短说明。格式为:(): 。
格式:type(scope) : subject
常用的提交类型包括

提交类型描述示例feat新功能增加(feature)feat: add user login featurefix修复BUGfix: correct user authenticationrefactor代码重构(既不是新增功能,也不是修复 Bug)refactor: simplify user validation logicdocs文档/注释docs: update API documentationstyle代码风格相关无影响运行结果的style: format code with prettiertest测试相关test: add unit tests for login featurebuild影响构建系统或外部依赖的更改(例如:gulp,broccoli,npm)build: update webpack configrevert代码撤销修改revert: revert commit 12345abcci持续集成的配置文件和脚本的变动(例如:Travis,Circle,BrowserStack,SauceLabs)ci: update Travis configurationchore依赖更新/脚手架配置修改等chore: upgrade React to the latest versionperf性能优化perf: optimize virtual DOM diffing algorithmGit 相关学习资料


  • Git从入门到实战详细教程
  • 工作中必备的12个Git命令
  • 最全面SourceTree使用教程详解
  • Git开发、发布、缺陷分离模型概述
  • 实际项目中如何使用Git做分支管理
  • 10款实用便捷的Git可视化管理工具
  • TortoiseGit使用教程(图文详细版)
  • VS Code使用Git可视化管理源代码详细教程
  • Git入门图文教程(1.5W字40图)--深入浅出、图文并茂
  • Visual Studio使用Git忽略不想上传到远程仓库的文件
  • 在开发过程中使用git rebase还是git merge,优缺点分别是什么?

来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
您需要登录后才可以回帖 登录 | 立即注册