当前位置:首页 > 编程技术 > 正文内容

git commit 代码提交规范

yc8881年前 (2022-12-07)编程技术267

git commit 代码提交规范

1. 前言


每个人 git 的提交记录都有自己的风格和习惯,特别是多人协作开发的项目,如果没有一套完整的规范,则每个人的代码提交描述内容会很随意,质量参差不齐,会降低 log 的可读性和维护性。所以,需要有一套 git 提交规范,使得提交记录清晰明了,让人一看就能知道每次提交的目的。本文记录一种业界比较认可和常用的规范,来自 AngularJS 团队规范

2. git commit 提交规范


提交描述信息格式: <type>(<scope>): <subject>

type: 操作类型

类型 描述
add 新增功能
update 更新功能
delete 删除功能
fix 修复 BUG
refactor 代码重构
revert 撤销上次commit
style 代码风格更改
docs 修改文档相关内容

scope: 影响范围

用于说明本次 commit 的影响范围,比如: 具体功能或模块,控制器层,业务层,模型层等,视项目不同而不同

subject: 简单描述

本次 commit 的简单描述,一般不超过 50 个字符。推荐以动词开头: 新增,修改,设置撤销等等

规范的提交信息示例:

  1. add(用户模块):新增用户编辑个人资料功能
  2. update(用户模块):修改用户编辑个人资料不需要上传头像
  3. delete(购物车模块):删除购物车批量删除商品功能
  4. fix(购物车模块):修复购物车商品数量可以为负数
  5. refactor(全部):初始化系统架构
  6. revert(用户模块):撤销修改用户编辑个人资料不需要上传头
  7. style(会员中心):格式化代码
  8. docs(api):更新API文档

本站发布的内容若侵犯到您的权益,请邮件联系站长删除,我们将及时处理!


从您进入本站开始,已表示您已同意接受本站【免责声明】中的一切条款!


本站大部分下载资源收集于网络,不保证其完整性以及安全性,请下载后自行研究。


本站资源仅供学习和交流使用,版权归原作者所有,请勿商业运营、违法使用和传播!请在下载后24小时之内自觉删除。


若作商业用途,请购买正版,由于未及时购买和付费发生的侵权行为,使用者自行承担,概与本站无关。


本文链接:https://www.10zhan.com/biancheng/10185.html

标签: git
分享给朋友:

“git commit 代码提交规范” 的相关文章

【说站】laravel实现自定义404页面并给页面传值

【说站】laravel实现自定义404页面并给页面传值

以 laravel5.8 为例,虽然有自带的404页面,但太简单,我们更希望能自定义404页面,将用户留在站点。实现的方式很简单,将自定义的视图文件命名为 404.blade.php,并放到 reso...

【说站】用一句话就可以去除宝塔面板操作上的二次验证

【说站】用一句话就可以去除宝塔面板操作上的二次验证

用过宝塔的朋友应该都会发现,现在宝塔面板有些鸡肋的功能,删除文件、删除数据库、删除站点等操作都需要做计算题!不仅加了几秒的延时等待,还无法跳过!这时候就会有朋友在想,如何去除宝塔面板的二次验证,此篇文...

【说站】Centos8.0如何配置静态IP详解及永久关闭防火墙

【说站】Centos8.0如何配置静态IP详解及永久关闭防火墙

这篇文章主要介绍了详解Centos8 配置静态IP的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来学习一下!1. 查看自己的网关地址点击虚...

【说站】电脑安装MySQL时出现starting the server失败原因及解决方案

【说站】电脑安装MySQL时出现starting the server失败原因及解决方案

今天在安装MySQL时出现starting the server失败,经过查询分析得出以下结论,记录一下操作步骤。原因分析:如果电脑是第一次安装MySQL,一般不会出现这样的报错。如下图所示。star...

【说站】C#在PDF中添加墨迹注释Ink Annotation的步骤详解

【说站】C#在PDF中添加墨迹注释Ink Annotation的步骤详解

PDF中的墨迹注释(Ink Annotation),表现为徒手涂鸦式的形状;该类型的注释,可任意指定形状顶点的位置及个数,通过指定的顶点,程序将连接各点绘制成平滑的曲线。下面,通过C#程序代码介绍如何...

【说站】Java从resources读取文件内容的方法有哪些

【说站】Java从resources读取文件内容的方法有哪些

本文主要介绍的是java读取resource目录下文件的方法,比如这是你的src目录的结构├── main│ ├── java│ │ └── ...