-
Notifications
You must be signed in to change notification settings - Fork 58
Expand file tree
/
Copy pathcommit.example
More file actions
49 lines (40 loc) · 2.79 KB
/
commit.example
File metadata and controls
49 lines (40 loc) · 2.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
好的!以下是为常见提交类型添加的 **Emoji 推荐**,结合社区常见用法和视觉直观性整理:
---
### **常用 Emoji 前缀**
| 类型 | Emoji | 示例 | 说明 |
|--------------|-------|----------------------|---------------------------------------|
| **`feat`** | ✨ | `✨ feat: 新增功能` | 新功能如星星般闪耀 |
| **`fix`** | 🐛 | `🐛 fix: 修复登录bug` | Bug 像小虫子一样被消灭 |
| **`docs`** | 📚 | `📚 docs: 更新API文档` | 文档如书本般厚重 |
| **`style`** | 🎨 | `🎨 style: 格式化代码` | 样式如调色板般美化代码 |
| **`refactor`**| ♻️ | `♻️ refactor: 重构模块`| 重构如循环箭头,优化代码结构 |
| **`test`** | ✅ | `✅ test: 添加单元测试`| 测试通过如打勾确认 |
| **`chore`** | 🔧 | `🔧 chore: 更新依赖` | 维护任务如工具调整 |
| **`build`** | 📦️ | `📦 build: 打包配置` | 构建如打包的箱子 |
| **`ci`** | 👷 | `👷 ci: 集成流水线` | 持续集成如工人施工 |
| **`perf`** | ⚡️ | `⚡️ perf: 优化渲染速度`| 性能如闪电般提升 |
| **`revert`** | ⏪️ | `⏪ revert: 回滚提交` | 回退如倒带箭头 |
| **`security`**| 🔒 | `🔒 security: 修复漏洞`| 安全如锁加固 |
| **`i18n`** | 🌐 | `🌐 i18n: 多语言支持` | 国际化如地球图标 |
| **`access`** | ♿️ | `♿️ access: 无障碍优化`| 无障碍如轮椅符号 |
| **`wip`** | 🚧 | `🚧 wip: 开发中功能` | 开发中如施工标志 |
| **`temp`** | ⏳ | `⏳ temp: 临时提交` | 临时如沙漏等待 |
---
### **使用场景建议**
1. **增强可读性**:Emoji 能快速吸引注意力,例如 `🐛 fix` 一眼看出是修复 Bug。
2. **统一风格**:团队约定一套 Emoji 规则,保持提交历史整洁。
3. **自动化工具兼容性**:大部分工具(如 `semantic-release`)支持带 Emoji 的提交。
---
### **提交示例**
```plaintext
✨ feat(auth): 新增第三方登录支持
📦 build: 升级 Webpack 到 v5
🐛 fix(ui): 修复按钮点击区域错误
```
---
### **其他 Emoji 参考**
- **`🔨`** (`chore`): 维护任务(替代 `🔧`)
- **`🚀`** (`deploy`): 部署相关
- **`🎉`** (`init`): 项目初始化
- **`💥`** (`breaking`): 重大变更(破坏性更新)
根据团队习惯调整 Emoji,保持灵活即可! 🌈