雷达智富

首页 > 内容 > 程序笔记 > 正文

程序笔记

git commit 代码提交规范

2024-09-28 21

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 个字符。推荐以动词开头: 新增,修改,设置撤销等等

规范的提交信息示例:

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

文章评论

评论问答