前言

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

git commit 规范写法示例

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

基本格式

首先一个规范的 git commit message 通常包含 Header、Body 和 Footer 三部分,各部分之间使用空行分隔。

<header>
// 空一行
<body>
// 空一行
<footer>

Header 必填

描述提交类型和简短说明。格式为:<类型>(<作用域>): <主题>(<type>(<scope>): <subject>)。

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

Body 可选

详细说明本次 commit 修改的内容。使用空行分隔段落,保持可读性。

- 新增微信支付SDK依赖
- 实现支付结果回调处理
- 添加支付相关的单元测试

Footer 可选

主要用于关联 Issue、描述破坏性变更(BREAKING CHANGE)等。

Closes #889
BREAKING CHANGE: 旧版支付回调接口已废弃,需迁移至 /api/v2/callback

实际工作常用的 git commit 规范写法

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

描述提交类型和简短说明。格式为:<类型>(<作用域>): <主题>

格式:type(scope) : subject

常用的提交类型包括

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

实际工作中 Git Commit 代码提交规范是什么样的?的更多相关文章

  1. git commit 代码提交规范

    格式 type: description 1. type 类型 type 是 commit 的类别,只允许如下几种标识: fix: 修复bug add: 新功能 update: 更新 refactor ...

  2. Git代码提交规范

    1. 引言 思想,因人而异,难以重复 写代码时,每个人的习惯是不一样的,所以,引入了代码规范,为了省力,引入了自动格式化代码工具,前端工程中比较典型的自动格式化代码工具如:Prettier · Opi ...

  3. Git Commit Template 提交模板

    多人协作开发一个项目时,版本控制工具是少不了的,git是linux 内核开发时引入的一个优秀代码管理工具,利用它能很好使团队协作完成一个项目.为了规范团队的代码提交,也方便出版本时的release n ...

  4. Git-【技术干货】工作中Git的使用实践

    Git-[技术干货]工作中Git的使用实践 置顶 2019-09-17 21:02:16 web洋仔 阅读数 11444更多 分类专栏: Git   版权声明:本文为博主原创文章,遵循CC 4.0 B ...

  5. git commit 代码时提示: Warning: Your console font probably doesn‘t support Unicode.

    git 提交代码是会遇到以下问题, git commit 代码时提示: Warning: Your console font probably doesn‘t support Unicode. If ...

  6. 工作中git 操作汇总

    1. git branch -l  查看本地branch 2. git reset --hard 回滚全部修改 3. git status  查看本地修改 4. git pull 更新代码 5. gi ...

  7. GIT库代码管理规范

    GIT库代码管理规范 一. 规范要求 1. 每个项目建立单独的GIT库.每个GIT库包括两条线,命名规则如下: 开发线(测试):项目名称_DEV 生产线(正式):项目名称 2. 每条线只允许增量不允许 ...

  8. Git操作: git commit代码后,如何撤回且保留commit的代码

    git commit代码后,但是没有push之前,如果发现提交的代码有一个部分是有问题的,或者commit message写的太随便了想改一下,以下命令会帮到你 git reset HEAD^ 敲击该 ...

  9. 运用python中装饰器方法来解决工作中为原有代码添加功能问题

          Python  装饰器 在实际的工作中,经常碰到领导或产品经理会提出很多甚至(变态)的产品要求,作为python开发,好不容易完成领导的需求,做出一个产品,并且经过测试成功上线.突然有一天 ...

  10. ubuntu16系统中pycharm下使用git将代码提交到github仓库

    1 在系统中安装git,在terminal中输入以下命令 sudo apt-get update sudo apt-get install git 2 对git进行配置,在terminal中输入以下命 ...

随机推荐

  1. 关于选择最佳.NET Core SSH服务器库的全面分析

    关于选择最佳.NET Core SSH服务器库的全面分析 在安全远程访问领域,SSH(安全外壳协议)服务器对于在潜在不安全的网络上实现客户端与服务器之间的安全通信至关重要.对于使用.NET Core的 ...

  2. Jupyter Notebook 一些常用的快捷键

    命令模式(按 Esc 进入): A:在当前单元格上方插入新单元格. B:在当前单元格下方插入新单元格. D + D(按两次 D 键):删除当前单元格. Z:撤销单元格删除. Ctrl + Enter: ...

  3. Typecho 从零开始搭建个人博客详细教程

    搭建Typecho个人博客需要进行一些准备工作.以下是大致的教学步骤: 1. 准备工作:    - 一台支持PHP和MySQL的服务器,可以是虚拟主机或者自己搭建的服务器.    - 一个域名,用于访 ...

  4. DeepSeek 不太稳定?那就搭建自己的 DeepSeek 服务

    概述 DeepSeek-R1 发布 DeepSeek 在 2025 年给我们送来一份惊喜,1 月 20 号正式发布第一代推理大模型 DeepSeek-R1.这个模型在数学推理.代码生成和复杂问题解决等 ...

  5. 赶快检查,木马可能已经植入服务器,Redis未授权访问漏洞记录,redis的key值出现backup要谨慎

    问题描述:为图省事,很多时候我们在使用redis的时候会使用默认空密码,这就增加了安全隐患,如果有下属情况,那赶快去检查下redis,木马或许已经植入服务器,应尽快处理: 1.redis绑定在 0.0 ...

  6. css 技巧:利用 after 伪对象和 background 属性实现 img 图片标签占位图

    同步发布:https://blog.jijian.link/2020-04-15/css-img-after-placeholder/ 如图: 图片加载失败了,在浏览器会默认显示一张破图.受各种网速. ...

  7. python 读写csv文件(创建,追加,覆盖)

    读取csv文件 利用 csv.reader 可以读 csv 文件,然后返回一个可迭代的对象 csv_read,我们可以直接从 csv_read 中取数据 import csv def read_csv ...

  8. maven为什么发生依赖冲突?怎么解决依赖冲突?

    maven为什么发生依赖冲突?怎么解决依赖冲突? 我们在开发的时候,偶尔会遇到依赖冲突的时候,一般都是NoClassDefFoundError.ClassNotFoundException.NoSuc ...

  9. element-ui和ant-design-vue 数字输入框只能输入大于等于1的整数

    限制输入的是大于等于1的整数 <template> <div> <h1>ant-design-vue 1.xx</h1> <a-input-num ...

  10. VMware ESXi系统

    esxi全称"VMware ESXi",是可直接安装在物理服务器上的强大的裸机管理系统,是一款虚拟软件,不需安装其他操作系统,是VMware服务器虚拟化的基础.通过直接访问并控制底 ...