自从有了以下提交建议,我每次提交代码都要来找找这次提交对应的emoji表情,后来觉得干脆分享出来,可以在提交代码的时候皮一皮...
以下git提交建议的文字描述来自alibaba的开源项目egg.js,git-commit规范;符号部分来自github里部分项目的emoji表情提交建议。
一、文字规范
commit一共由五部分组成,具体内容如下。
(1)type
提交 commit 的类型,包括以下几种
feat: 新功能
fix: 修复问题
docs: 修改文档
style: 修改代码格式,不影响代码逻辑
refactor: 重构代码,理论上不影响现有功能
perf: 提升性能
test: 增加修改测试用例
chore: 修改工具相关(包括但不限于文档、代码生成等)
deps: 升级依赖
(2)scope
修改文件的范围(包括但不限于 doc, middleware, core, config, plugin)
(3)subject
用一句话清楚的描述这次提交做了什么
(4)body
补充 subject,适当增加原因、目的等相关因素,也可不写。
(5)footer
当有非兼容修改(Breaking Change)时必须在这里描述清楚
关联相关 issue,如
Closes #1, Closes #2, #3
如果功能点有新增或修改的,还需要关联文档
doc
二、emoji规范
注:以下emoji表情在git提交时已经完全支持,哪怕下面的表情显示不完整也不用慌,可以直接在git-submit里使用。