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 个字符。推荐以动词开头: 新增,修改,设置撤销等等
规范的提交信息示例:
更新于:16天前add(用户模块):新增用户编辑个人资料功能
update(用户模块):修改用户编辑个人资料不需要上传头像
delete(购物车模块):删除购物车批量删除商品功能
fix(购物车模块):修复购物车商品数量可以为负数
refactor(全部):初始化系统架构
revert(用户模块):撤销修改用户编辑个人资料不需要上传头
style(会员中心):格式化代码
docs(api):更新API文档
赞一波!
相关文章
- 【说站】java语言代码大全
- 【说站】python代码提速有哪些方法
- iOS 图片压缩方法的示例代码
- php语法技巧代码实例
- PHP平滑关闭/重启的实现代码
- PHP实现生成二维码代码展示
- git clean 命令详解
- git 常用命令
- git switch 命令详解
- git rebase 命令详解
- 谷歌的代码即政策允许机器人编写自己的代码
- 自研、好用、够快、稳定、代码可读性强的ORM
- git status 查看状态文件名乱码
- git stash 命令详解(保存开发进度)
- git fetch 命令详解
- PHP 代码复用机制 trait
- git merge 命令详解
- .git 目录结构内容解析
- git clone 拉取远程仓库
- git tag 命令详解
文章评论
评论问答