Git提交规范,GitHub表情规范指南

简介

使用git很久了一直都随便写commit信息,导致查看历史时比较混乱,所以搜集了网上的提交规范,摘录到这里备用

提交规范

格式:括号中部分的可以省略

1
2
3
4
5
<type>(<scope>): <subject>
<BLANK LINE>
(<body>)
<BLANK LINE>
(<footer>)

  • header: 只有一行,包括三个字段:type、scope、subject
    • type: 提交的类别
    • scope: 影响的范围,比如数据层、控制层、视图层等等(可空)
    • subject: 描述
  • body: 提交的类别(可空)
  • footer: 不兼容变动、Close Issue、Revert等

type的类型:

类型 描述
feat 新功能(feature)
fix 修补bug
docs 文档(documentation)
style 格式(不影响代码运行的变动)
refactor 重构(即不是新增功能,也不是修改bug的代码变动)
test 增加测试
chore 构建过程或辅助工具的变动

GitHub表情指南

emoji emoji 代码 commit 说明
🎉 (庆祝) :tada: 初次提交
✨ (火花) :sparkles: 引入新功能
🔖 (书签) :bookmark: 发行/版本标签
🐛 (bug) :bug: 修复 bug
🚑 (急救车) :ambulance: 重要补丁
🌐 (地球) :globe_with_meridians: 国际化与本地化
💄 (口红) :lipstick: 更新 UI 和样式文件
🎬 (场记板) :clapper: 更新演示/示例
🚨 (警车灯) :rotating_light: 移除 linter 警告
🔧 (扳手) :wrench: 修改配置文件
➕ (加号) :heavy_plus_sign: 增加一个依赖
➖ (减号) :heavy_minus_sign: 减少一个依赖
⬆️ (上升箭头) :arrow_up: 升级依赖
⬇️ (下降箭头) :arrow_down: 降级依赖
⚡️ (闪电) :zap: 提升性能
🐎 (赛马) :racehorse: 提升性能
📈 (上升趋势图) :chart_with_upwards_trend: 添加分析或跟踪代码
🚀 (火箭) :rocket: 部署功能
✅ (白色复选框) :white_check_mark: 增加测试
📝 (备忘录) :memo: 撰写文档
🔨 (锤子) :hammer: 重大重构
🎨 (调色板) :art: 改进代码结构/代码格式
🔥 (火焰) :fire: 移除代码或文件
✏️ (铅笔) :pencil2: 修复 typo
🚧 (施工) :construction: 工作进行中
👷 (工人) :construction_worker: 添加 CI 构建系统
💚 (绿心) :green_heart: 修复 CI 构建问题
🔒 (锁) :lock: 修复安全问题
🐳 (鲸鱼) :whale: Docker 相关工作
🍎 (苹果) :apple: 修复 macOS 下的问题
🐧 (企鹅) :penguin: 修复 Linux 下的问题
🏁 (旗帜) :checked_flag: 修复 Windows 下的问题

原项目链接:git commit message emoji 使用指南
参考:gitmoji

文章目录
  1. 1. 简介
    1. 1.1. 提交规范
    2. 1.2. GitHub表情指南