Emoji 的使用
· 阅读需 2 分钟
在 CHANGELOG.md
文件中,使用 Emoji 可以直观标识不同类型的变更。以下是常见的 Emoji 及其含义:
常用 Emoji 分类
Emoji | 含义 | 示例场景 |
---|---|---|
✨ | 新功能 | 新增模块、API 或重大特性 |
🐛 | Bug 修复 | 修复代码缺陷、崩溃问题 |
🚀 | 性能优化 | 提升速度、减少资源占用 |
🎨 | 代码/UI 改进 | 重构代码、优化交互设计 |
📚 | 文档更新 | 完善文档、教程或注释 |
⚠️ | 弃用警告 | 标记即将弃用的功能 |
🔧 | 配置变更 | 修改配置文件或环境变量 |
🔒 | 安全修复 | 修补安全漏洞 |
🌐 | 国际化 | 支持新语言或本地化优化 |
🚨 | 重要变更 | 破坏性的 API 变更 |
🎉 | 初始版本 | 项目首次发布 |
使用示例
## [1.2.0] - 2023-04-06
### 新增功能 ✨
- 新增用户登录验证码功能
### Bug 修复 🐛
- 修复首页加载缓慢的 bug
### 性能优化 🚀
- 优化数据库查询效率
### 文档更新 📚
- 完善 API 文档示例
最佳实践
- 一致性:
在团队中统一 Emoji 使用规范,避免混淆。 - 简洁性:
每个变更类型使用 1 个 Emoji,避免过度使用。 - 语义化:
确保 Emoji 准确反映变更类型。
通过合理使用 Emoji,可以让 CHANGELOG.md
更清晰易读。