mirror of
https://github.com/BTMuli/TeyvatGuide.git
synced 2026-04-02 06:45:08 +08:00
🧑💻 添加 Git 提交规则文档
This commit is contained in:
BTMuli
50
.trae/rules/git-commit-rules.md
Normal file
50
.trae/rules/git-commit-rules.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Git Commit 规则
|
||||
|
||||
## 核心规则
|
||||
|
||||
1. **分步提交**：分步执行 `git add <文件路径>` 再 `git commit -m "<emoji> <描述>"`
|
||||
2. **单一 emoji**：每条提交只使用一个 emoji，位于开头
|
||||
3. **Unicode 格式**：使用 Unicode emoji 图标（如 ✨），不要纯文本（如 `:sparkles:`）
|
||||
4. **中文描述**：以动词开头，一行不超过 100 字符
|
||||
5. **禁止 type: 声明**：不要使用 `✨ feat: xxx` 格式
|
||||
|
||||
## 提交格式
|
||||
|
||||
```
|
||||
<emoji> <描述>
|
||||
```
|
||||
|
||||
## Emoji 速查
|
||||
|
||||
| 类别 | Emoji | 场景 |
|
||||
|------|-------|------|
|
||||
| 新增 | ✨ | 新功能 |
|
||||
| 新增 | 🎨 | 代码结构/格式 |
|
||||
| 新增 | 📝 | 文档 |
|
||||
| 修改 | 🐛 | Bug 修复 |
|
||||
| 修改 | 🩹 | 小修复/补丁 |
|
||||
| 修改 | ⚡️ | 性能优化 |
|
||||
| 修改 | ♻️ | 重构 |
|
||||
| 修改 | 💄 | UI/样式 |
|
||||
| 删除 | 🔥 | 删除代码/文件 |
|
||||
| 删除 | ⚰️ | 删除死代码 |
|
||||
| 依赖 | ➕ | 添加依赖 |
|
||||
| 依赖 | ➖ | 删除依赖 |
|
||||
| 依赖 | ⬆️ | 升级依赖 |
|
||||
| 部署 | 🚀 | 部署 |
|
||||
| 部署 | 📦 | 编译/打包 |
|
||||
| 数据库 | 🗃️ | 数据库变更 |
|
||||
| 安全 | 🔒 | 安全问题 |
|
||||
| 架构 | 🏗️ | 架构变更 |
|
||||
| 体验 | 🧑💻 | 开发体验 |
|
||||
| 进行中 | 🚧 | 进行中工作 |
|
||||
|
||||
## 示例
|
||||
|
||||
```
|
||||
✨ 添加用户个人页面跳转功能
|
||||
🐛 修复角色生日判断逻辑
|
||||
🩹 补充首页mini参数处理
|
||||
♻️ 重构数据库操作为事务模式
|
||||
⚡️ 优化角色列表渲染性能
|
||||
```
|
||||
164
.trae/skills/git-commit-skill/SKILL.md
Normal file
164
.trae/skills/git-commit-skill/SKILL.md
Normal file
@@ -0,0 +1,164 @@
|
||||
---
|
||||
name: "git-commit-skill"
|
||||
description: "Git commit 规范参考。Invoke when user wants to make commits, including selective file staging, proper gitmoji usage, and commit message format."
|
||||
---
|
||||
|
||||
# Gitmoji Commit 规范
|
||||
|
||||
本文档定义了项目提交信息的格式规范，确保提交历史清晰可读。
|
||||
|
||||
## 提交格式
|
||||
|
||||
```
|
||||
<emoji> <描述>
|
||||
```
|
||||
|
||||
- **emoji**：使用 Unicode emoji 图标，放在提交信息开头
|
||||
- **描述**：使用中文，以动词开头，简短明了
|
||||
- **一行不超过 100 字符**
|
||||
- **禁止括号声明**：不要使用 `✨ feat(xxx)` 或 `✨ feat` 这种格式，仅保留图标
|
||||
|
||||
## Emoji 选择指南
|
||||
|
||||
根据变更类型选择对应的 emoji：
|
||||
|
||||
### 🆕 新增内容
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| ✨ | 新功能 | `✨ 添加用户个人页面跳转功能` |
|
||||
| 🎨 | 代码结构/格式 | `🎨 重构角色卡片组件` |
|
||||
| 📝 | 文档 | `📝 更新 README` |
|
||||
| 🎉 | 初始项目 | `🎉 初始化项目` |
|
||||
| ✅ | 测试 | `✅ 添加角色查询单元测试` |
|
||||
|
||||
### 🔧 修改内容
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🐛 | Bug 修复 | `🐛 修复角色生日判断逻辑` |
|
||||
| 🩹 | 小修复/补丁 | `🩹 补充首页mini参数处理` |
|
||||
| ⚡️ | 性能优化 | `⚡️ 优化角色列表渲染性能` |
|
||||
| ♻️ | 重构 | `♻️ 重构数据库操作层` |
|
||||
| 💄 | UI/样式 | `💄 调整首页卡片布局` |
|
||||
| ✏️ | 拼写错误 | `✏️ 修复注释拼写` |
|
||||
| 💡 | 注释/解释 | `💡 添加关键逻辑注释` |
|
||||
|
||||
### 🗑️ 删除/清理
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🔥 | 删除代码/文件 | `🔥 移除废弃组件` |
|
||||
| ⚰️ | 删除死代码 | `⚰️ 清理未使用的导入` |
|
||||
| 🗑️ | 代码弃用 | `🗑️ 弃用旧版API` |
|
||||
|
||||
### 📦 依赖/配置
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| ➕ | 添加依赖 | `➕ 添加图表库依赖` |
|
||||
| ➖ | 删除依赖 | `➖ 移除冗余依赖` |
|
||||
| ⬆️ | 升级依赖 | `⬆️ 升级 Vue 版本` |
|
||||
| ⬇️ | 降级依赖 | `⬇️ 降级兼容版本` |
|
||||
| 📌 | 锁定版本 | `📌 锁定构建工具版本` |
|
||||
| 🔧 | 配置文件 | `🔧 更新 vite 配置` |
|
||||
| 🔨 | 开发脚本 | `🔨 添加自动化脚本` |
|
||||
|
||||
### 🚀 部署/构建
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🚀 | 部署 | `🚀 部署生产环境` |
|
||||
| 📦 | 编译/打包 | `📦 更新构建产物` |
|
||||
| 👷 | CI/CD | `👷 优化 GitHub Actions` |
|
||||
|
||||
### 🗄️ 数据/存储
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🗃️ | 数据库 | `🗃️ 添加角色收藏表` |
|
||||
| 🌱 | 种子数据 | `🌱 初始化角色数据` |
|
||||
|
||||
### 🌐 国际化/本地化
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🌐 | 国际化 | `🌐 添加多语言支持` |
|
||||
|
||||
### 🔒 安全/权限
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🔒 | 安全问题 | `🔒 修复XSS漏洞` |
|
||||
| 🔐 | 密钥/凭证 | `🔐 更新API密钥配置` |
|
||||
|
||||
### 📊 分析/监控
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 📈 | 分析/跟踪 | `📈 添加埋点统计` |
|
||||
| 🔊 | 添加日志 | `🔊 添加操作日志` |
|
||||
| 🔇 | 删除日志 | `🔇 清理调试日志` |
|
||||
|
||||
### 🏗️ 架构/基础设施
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🏗️ | 架构变更 | `🏗️ 引入状态管理` |
|
||||
| 🧱 | 基础设施 | `🧱 优化 Docker 配置` |
|
||||
|
||||
### 🧑💻 开发体验
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🧑💻 | 开发体验 | `🧑💻 优化热更新速度` |
|
||||
| 🚸 | 用户体验 | `🚸 统一导出交互流程` |
|
||||
| 💫 | 动画/过渡 | `💫 添加页面转场动画` |
|
||||
|
||||
### 🔀 分支/版本
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🔀 | 合并分支 | `🔀 合并功能分支` |
|
||||
| ⏪ | 回滚 | `⏪ 回滚错误提交` |
|
||||
| 🔖 | 版本标签 | `🔖 发布 v1.0.0` |
|
||||
|
||||
### 其他
|
||||
| Emoji | 场景 | 示例 |
|
||||
|-------|------|------|
|
||||
| 🚧 | 进行中 | `🚧 实现角色对比功能` |
|
||||
| 💚 | CI 修复 | `💚 修复构建失败` |
|
||||
| 🚨 | 警告修复 | `🚨 消除编译器警告` |
|
||||
| 👔 | 业务逻辑 | `👔 添加抽卡概率计算` |
|
||||
| 🩺 | 健康检查 | `🩺 添加服务监控` |
|
||||
| 🧐 | 数据检查 | `🧐 审查数据一致性` |
|
||||
| 🛂 | 权限/授权 | `🛂 添加角色权限校验` |
|
||||
| 🦺 | 验证 | `🦺 添加参数校验` |
|
||||
| 🧵 | 多线程/并发 | `🧵 优化异步任务处理` |
|
||||
| ✈️ | 离线支持 | `✈️ 提升离线体验` |
|
||||
| 🦖 | 向后兼容 | `🦖 添加兼容性处理` |
|
||||
| 💸 | 金钱相关 | `💸 优化资源加载成本` |
|
||||
| 👽 | API 变更 | `👽 适配新版API` |
|
||||
| 🚚 | 移动/重命名 | `🚚 迁移文件到新目录` |
|
||||
| 📄 | 许可证 | `📄 添加 MIT 许可证` |
|
||||
| 💥 | 重大变更 | `💥 重构核心模块` |
|
||||
| 🍱 | 静态资源 | `🍱 更新应用图标` |
|
||||
| ♿️ | 无障碍 | `♿️ 添加ARIA标签` |
|
||||
| 🏷️ | 类型定义 | `🏷️ 完善类型定义` |
|
||||
| 🚩 | 功能开关 | `🚩 添加灰度开关` |
|
||||
| ⚗️ | 实验 | `⚗️ 尝试新方案` |
|
||||
| 🔍 | SEO | `🔍 优化页面索引` |
|
||||
| 🙈 | .gitignore | `🙈 更新gitignore规则` |
|
||||
| 📸 | 快照 | `📸 添加截图` |
|
||||
| 🥚 | 彩蛋 | `🥚 添加开发者彩蛋` |
|
||||
| 🤡 | Mock | `🤡 添加mock数据` |
|
||||
| 🍻 | 酒后代码 | `🍻 修复奇怪bug` |
|
||||
| 💬 | 文本更新 | `💬 更新界面文案` |
|
||||
| 👥 | 贡献者 | `👥 更新贡献者列表` |
|
||||
|
||||
## 提交示例
|
||||
|
||||
```
|
||||
✨ 添加用户个人页面跳转功能
|
||||
🐛 修复角色生日判断逻辑，优化返回结果
|
||||
🩹 补充首页mini参数&组件参数处理
|
||||
♻️ 重构数据库操作为事务模式
|
||||
⚡️ 优化角色列表渲染性能
|
||||
💄 调整深色模式配色方案
|
||||
📝 添加组件使用文档
|
||||
⬆️ 更新依赖版本，修复安全警告
|
||||
🔧 更新 vite 配置以支持新插件
|
||||
🚸 统一UIGF导出交互，导出前选择导出路径
|
||||
💫 添加页面转场动画效果
|
||||
🐛 修复抽卡记录导出为空的问题
|
||||
🏗️ 引入 Pinia 状态管理
|
||||
🧑💻 优化热更新加载速度
|
||||
```
|
||||
Reference in New Issue
Block a user