--- description: Git 提交信息使用中文,并符合 commitlint 规范 alwaysApply: true --- # Git Commit Message 生成规则 当在 **Chat / Composer** 中请求生成或改写 git commit message 时,必须遵守以下规则(注意:左侧 Source Control 的 ✨「生成提交信息」**不会**读取本规则,请用 Chat/Composer 生成后复制到提交框)。 ## 规范要点 1. **格式**:`type(scope): 描述` - **type**:仅用英文,且为 commitlint 允许之一:`feat` `fix` `docs` `style` `refactor` `perf` `test` `build` `ci` `chore` `revert` `wip` `workflow` `types` `release`。 - **scope**:可选,填写改动所在模块/目录/功能(如 `离职管理`、`elementReset/column`、`unocss`)。 - **描述**:中文,一句话说清「改了哪一块 + 改了什么」。 2. **描述要求**: - 先点出**修改范围**(页面名、模块名、或功能点),再简要说明**具体改动**。 - 不写笼统的「优化代码」「修复 bug」,要能看出本次改的是哪一块、做了什么。 3. **示例**(符合规范): - `feat(离职管理): 表格列宽按 1920 基准随屏幕宽度缩放` - `refactor(elementReset): 将列宽配置与 JtTableColumn 收拢到 column 子目录` - `fix(表格列): 列宽通过 App.vue provide/inject,resize 监听在卸载时移除` - `chore(unocss): 移除 attributify,仅保留 class 生成样式` - `docs(commit): 补充中文 commit 规范与变通用法` 4. **示例**(不符合规范,避免): - `fix: 修复 bug`(未说明改了什么、哪一块) - `update`(无 type、无范围、无中文描述) 生成时根据本次 diff 确定 type、scope,并在描述中写清修改范围与改动内容。 ## 变通:如何得到中文 commit message 左侧 ✨ 按钮目前不会应用项目规则。请:暂存改动 → 在 Chat 或 Composer 中输入「根据暂存生成一条符合项目规范的中文 commit,写清改了哪一块和改了什么」→ 将生成的一行复制到提交框。