--- alwaysApply: true scene: git_message --- # Git Commit Message 规范(Vue3 + TS 项目专用) 请严格遵循 **Conventional Commits** 格式生成提交信息: `[type]([scope]): [subject]` --- ## 1. 提交类型(必填,只能用以下列表) | 类型 | 说明 | | :--------- | :------------------------------------------------------- | | `feat` | 新增功能/模块/页面 | | `fix` | 修复 Bug(包括样式、逻辑、交互问题) | | `docs` | 仅修改文档、注释 | | `style` | 仅调整代码格式(空格、换行、分号等,不影响逻辑) | | `refactor` | 重构代码(既不新增功能,也不修复 Bug) | | `perf` | 性能优化(渲染、请求、加载速度等) | | `test` | 新增/修改测试用例 | | `build` | 构建流程、依赖项、打包配置变更 | | `ci` | CI/CD 配置变更 | | `chore` | 其他不影响源码/测试的变更(如 `.gitignore`、编辑器配置) | --- ## 2. 作用域(必填,根据你的项目目录填写) 必须从以下模块中选择,保持与项目结构一致: - `views`: 页面/路由视图(如首页、列表页、详情页) - `components`: 公共组件/业务组件 - `stores`: Pinia 状态管理 - `router`: 路由配置 - `utils`: 工具函数/通用方法 - `assets`: 静态资源(图片、样式文件) - `config`: 配置文件(如 robotConfig.ts) - `data`: 模拟数据/常量配置 - `App`: 根组件/全局配置 - `config`: 构建/环境配置(如 vite.config.ts、tsconfig.json) --- ## 3. 主题描述(必填) - 语言:优先使用英文,若中文更清晰也可使用 - 长度:不超过 72 个字符 - 格式:动宾结构,清晰描述变更内容,结尾不加句号 - 禁止:模糊描述(如“修改代码”、“调整样式”) --- ## 4. 完整示例(直接参考格式) ✅ 正确示例: - `feat(views): add elderly institution list page` - `fix(components): fix modal title background color issue` - `refactor(stores): optimize user info store logic` - `chore: update gitignore rules` - `perf(utils): optimize echarts data processing function` ❌ 错误示例: - `修改了一些东西` - `feat: 做了个新功能` - `fix(views): 改了页面` --- ## 5. 额外要求 1. 一次提交尽量只做一件事,避免多类型变更混在一起 2. 若变更涉及多个模块,可在 `scope` 中用逗号分隔(如 `feat(views, components): add new page and related components`) 3. 重大变更可在提交信息的 body 中补充说明(可选)