GitHub release以及Git Commit常用模板
前言
最近发现Lobe Chat的Commit和Release内容都很美观,找Gemini要了个模板过来。
Git Commit 模板
结构:
1 | <emoji> <type>(<scope>): <subject> |
常用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 | ✨ feat(profile): 新增用户个人资料编辑页面 |
Release 模板
结构:
1 | # 🎉 Release v[版本号] - [发布日期] |
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 GoodBoyboy 's Blog|惬意小屋-点滴记忆!
Invitation
GoodBoyboy
5201314***
created:09/04/2015
Welcome to MyBlog
Use this card to join MyBlog and participate in a pleasant discussion together .
Welcome to GoodBoyboy 's Blog,wish you a nice day .
评论
ArtalkUtterances