git-commit-helper

Overview

按固定三步流程协助用户完成 Git 提交：先展示变更文件列表，再生成 commit 信息供用户确认或自定义，最后执行 push。

流程概览

1. 对比变更 → 2. 生成/确认 commit 信息 → 3. git push

流程 1：对比工作区变更

使用 Git 命令对比当前工作区与暂存区/HEAD 的差异，以列表形式展示改动的文件。

执行步骤

1. 运行 git branch --show-current 获取当前分支，在展示中优先显示，避免提交到错误分支
2. 运行 git status -sb 获取简要状态
3. 运行 git diff --stat 或 git diff --name-status 获取变更文件列表
4. 若有未暂存变更，可运行 git diff 查看具体改动

输出格式

以列表形式展示，开头必须展示当前分支，例如：

## 当前分支

**main**（请确认是否为预期分支）

## 变更文件列表

| 状态 | 文件路径                  |
| ---- | ------------------------- |
| M    | src/utils/helper.ts       |
| A    | src/components/Button.tsx |
| D    | old-file.js               |

• M = 修改 (Modified)
• A = 新增 (Added)
• D = 删除 (Deleted)
• R = 重命名 (Renamed)

展示完成后，询问用户是否继续进入流程 2。

流程 2：生成并确认 commit 信息

2.1 自动生成 commit 信息

根据当前分支名、git diff 和变更文件内容，生成 commit message。参考 references/conventional-commits.md。

分支为 work-{key}-{task_number}-* 时，格式：{KEY}-{TASK_NUMBER} {type} {description}

示例：FUW-14638 feat 加入注释

分支不符合上述格式时，使用默认格式：{type} {description}（如 feat 添加登录校验）

2.2 用户确认

将生成的 commit 信息展示给用户，并询问：

• 使用此条：进入流程 3，执行 git add + git commit
• 不使用：提示用户在对话框内输入新的 commit 信息，收到后执行 git add + git commit

2.3 用户自定义

当用户选择不使用自动生成的 message 时：

• 明确提示：请在对话框中输入你希望使用的 commit 信息
• 等待用户输入
• 收到用户输入后，使用该内容执行 commit

流程 3：执行 git push

在完成 git add 和 git commit 后：

1. 运行 git push（或 git push origin <branch>，根据当前分支）
2. 若 push 失败（如需 pull、冲突等），将错误信息告知用户并给出处理建议

注意事项

• 展示变更前必须先显示当前分支，提醒用户确认分支是否正确
• 执行 git add 前，确认用户已看过变更列表并同意提交范围
• 若工作区有未暂存变更，询问用户是否 git add . 或指定文件
• 若 git push 提示需要 git pull，先执行 git pull --rebase 或 git pull，再 push

Resources

references/conventional-commits.md

Conventional Commits 规范与 type 说明，用于生成 commit 信息时参考。

commands/git-prepush.md

Cursor 命令定义。将本文件复制到项目 .cursor/commands/ 目录下，即可在聊天框通过 /git-prepush 调用本技能完整流程。