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 个字符。推荐以动词开头: 新增,修改,设置撤销等等
规范的提交信息示例:
add(用户模块):新增用户编辑个人资料功能
update(用户模块):修改用户编辑个人资料不需要上传头像
delete(购物车模块):删除购物车批量删除商品功能
fix(购物车模块):修复购物车商品数量可以为负数
refactor(全部):初始化系统架构
revert(用户模块):撤销修改用户编辑个人资料不需要上传头
style(会员中心):格式化代码
docs(api):更新API文档
本站发布的内容若侵犯到您的权益,请邮件联系站长删除,我们将及时处理!
从您进入本站开始,已表示您已同意接受本站【免责声明】中的一切条款!
本站大部分下载资源收集于网络,不保证其完整性以及安全性,请下载后自行研究。
本站资源仅供学习和交流使用,版权归原作者所有,请勿商业运营、违法使用和传播!请在下载后24小时之内自觉删除。
若作商业用途,请购买正版,由于未及时购买和付费发生的侵权行为,使用者自行承担,概与本站无关。