LHJ's Blog

🍎 Git提交规范

📗 统一Git提交规范可以方便管理团队代码,方便后续进行code review以及生成change log

📘 规范Git提交格式容易理解提交的信息

🍏 Git版本提交规范

🔴 分支规范

🔶 master分支,属于受保护的分支,一般不可以直接提交代码到master分支。

🔷 develop分支,测试分支;开发完成的代码合并到这个分支进行功能测试。

🔷 feature分支,开发分支;根据需要创建独立的开发分支进行开发,然后合并到develop分支。

🔷 fix分支,bug修复分支;根据情况对代码漏洞进行修复,修复完成后合并到develop分支。

🔴 标签

采用三段式: v版本.里程碑.序号,例如v1.2.1

🔷 项目结构发生重大修改,增加第一个数字

🔷 发布新的功能,增加第二个数字

🔷 修复项目中的bug,修改第三个数字

🍏 Git Commit信息规范

目前一般采用Angular的提交信息规范:信息分为HeaderBodyFooter三部分

📘 Header

信息分为三部分type(scope):subject

🔶 type(必须),用于说明Git提交信息的类别,有以下几个分类

Type 说明
feat 新增功能
fix 修复bug
docs 修改文档
refactor 重构代码,未新增任何功能或修复任何bug
build 改变构建流程、新增依赖库
style 仅对样式做出修改(如空格和代码缩进等,不对逻辑进行修改)
perf 改善性能的修改
chore 非src或test下代码的修改
test 测试用例的修改
ci 自动化流程配置修改
revert 回滚到上一个版本
🔷 scope(可选),用于说明commit的影响范围

🔶 subject(必须),commit的信息主题,尽量言简意赅,说明提交代码的主要变化

📘 Body

对本次提交的详细描述

🔷 不兼容变动(需要说明变动信息)

🔷 关闭issue(需要输入issue信息)

🍏 提交信息添加emoji

使用emoji提交信息只是好看、好玩而已,存粹看个人爱好,工作不建议使用

先看看效果:

可以看到有一个小图标在旁边,挺有意思的。

使用方法:

其中的:pencil:就是图标了,更多图标在这里


 评论