前言

最近发现Lobe Chat的Commit和Release内容都很美观,找Gemini要了个模板过来。

Git Commit 模板

结构:

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

常用Emoji与类型:

Emoji 类型(type) 描述 示例
feat 新增功能 (A new feature) ✨ feat(api): 新增用户注册接口
🐛 fix 修复 Bug (A bug fix) 🐛 fix(payment): 修复微信支付回调失败的问题
📝 docs 仅修改文档 (Documentation only changes) 📝 docs(readme): 更新项目介绍和安装指南
💄 style 代码格式调整,不影响代码逻辑 (A code style update) 💄 style(lint): 调整 ESLint 规则并格式化所有 .js 文件
♻️ refactor 代码重构,既不是修复 bug 也不是新增功能 ♻️ refactor(user): 重构用户认证模块,提升性能
⚡️ perf 提升性能的改动 (A code change that improves performance) ⚡️ perf(image): 优化图片加载速度,采用懒加载
test 增加或修改测试 (Adding missing tests or correcting existing tests) ✅ test(utils):为日期格式化函数增加单元测试
🔨 build 影响构建系统或外部依赖的更改 🔨 build(deps): 升级 webpack 到 v5
⚙️ ci 更改 CI 配置文件和脚本 ⚙️ ci(github): 优化 GitHub Actions 的构建流程
🧹 chore 其他不修改 src 或 test 文件的更改 🧹 chore(release): 准备 v1.2.0 版本发布
⏪️ revert 回滚一个之前的 commit ⏪️ revert(feat): 回滚上次的用户权限更新
🚀 deploy 部署相关 🚀 deploy(prod): 部署 v2.0.0 到生产环境
🚧 wip 工作进行中 (Work in progress) 🚧 wip(search): 搜索功能初步实现,请勿合并
🎉 release 发布新版本 🎉 release: v3.0.0
⬆️ upgrade 升级依赖 (Upgrade dependencies) ⬆️ upgrade(react): 升级 React 到 v18
⬇️ downgrade 降级依赖 (Downgrade dependencies) ⬇️ downgrade(lodash): 降级 lodash 解决兼容性问题

示例

一个简单的修复:

1
🐛 fix(header): 修复移动端视图下导航栏溢出的问题

一个包含详细描述的新功能:

1
2
3
4
5
6
✨ feat(profile): 新增用户个人资料编辑页面

- 用户现在可以上传头像、修改昵称和个人简介。
- 增加了输入验证,确保数据的有效性。

Closes #123

Release 模板

结构:

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
# 🎉 Release v[版本号] - [发布日期]

[这里可以写一段简短的发布介绍,比如 "我们很高兴地宣布 XX 版本的发布!本次更新带来了期待已久的新功能并修复了若干重要问题。"]

## ✨ 新功能 (Features)

- 新增用户注册功能,现在可以通过邮箱或手机号注册 (#101)
- 增加了全新的仪表盘页面,提供数据可视化图表 (#105)
- 支持通过 OAuth2 与 Google 账户集成登录 (#112)

## 🐛 Bug 修复 (Bug Fixes)

- 修复了在 Safari 浏览器中日期选择器无法弹出的问题 (#98)
- 解决了特定场景下可能导致内存泄漏的 Bug (#102)
- 修正了 API 文档中一个错误的参数示例 (#108)

## ♻️ 重构与优化 (Refactoring & Performance)

- 重构了支付模块,提升了代码可维护性 (#95)
- 优化了首页的加载性能,首次渲染时间减少 30% (#100)
- 升级了数据库查询逻辑,响应速度更快 (#110)

## 📝 文档 (Documentation)

- 更新了 `README.md` 文件,包含了最新的安装和使用指南 (#97)
- 增加了贡献指南 `CONTRIBUTING.md` (#99)

## 🔨 构建与依赖 (Build & Dependencies)

- 将项目依赖的 Node.js 版本升级至 v20 (#115)
- 引入了 `Vite` 作为新的构建工具,大幅提升开发服务器启动速度 (#120)

---

### ❤️ 贡献者 (Contributors)

感谢以下所有为这个版本做出贡献的开发者!

[@username1](https://github.com/username1)
[@username2](https://github.com/username2)
...

---