使用 AI Workflow 规范化团队 Commit 信息:从混乱到有序

📖 背景:Commit 信息的痛点

在团队协作开发中,你是否遇到过这些问题?

bash 复制代码
# 😱 混乱的 commit 历史
git log --oneline
a1b2c3d 修复bug
e4f5g6h update
i7j8k9l 临时提交
m0n1o2p 改了点东西
q3r4s5t fix

这样的 commit 信息会导致:

  • ❌ 无法快速了解每次提交的目的
  • ❌ 难以追踪 bug 的引入时间
  • ❌ 无法自动生成有意义的 changelog
  • ❌ 代码审查效率低下
  • ❌ 团队协作混乱

💡 解决方案:AI Workflow + 规范化 Commit

本文将介绍如何使用 AI Workflow 来解决这个问题,让团队的每一次提交都清晰、规范、有意义。

什么是 AI Workflow?

想象一下,你有一个非常靠谱的助手,你只需要告诉他:"帮我写 commit 信息",他就会:

  1. 自动检查你改了哪些代码
  2. 分析改动的类型和目的
  3. 按照团队规范生成完美的 commit 信息
  4. 提供可直接执行的命令

AI Workflow 就是这样一个"智能助手"!

通过在项目中创建 .agent/workflows/*.md 文件,你可以:

  • ✅ 定义标准化的工作流程
  • ✅ 让 AI 自动分析代码改动
  • ✅ 生成符合规范的输出
  • ✅ 提高团队协作效率

🎯 动手实践:搭建你的 AI 助手

💡 温馨提示:这部分会手把手教你配置,就像组装乐高一样简单!即使你是新手也完全 OK。

🎬 开始之前

想象一下,你正在给自己的项目配一个"智能秘书",它能帮你:

  • 📝 自动写规范的 commit 信息
  • 🤖 永远不会忘记团队规范
  • ⚡ 每次提交节省 3-5 分钟

听起来很酷?让我们开始吧!


第一步:告诉 AI "我们的规矩是什么"

就像制定游戏规则

你玩过桌游吗?每个游戏都有规则手册。我们要做的就是给 AI 写一本"commit 规则手册"。

我们的规则很简单:

makefile 复制代码
类型(范围): 做了什么

详细说明(可选)

举个栗子 🌰:

bash 复制代码
# 😊 好的 commit(一看就懂)
feat(登录): 添加微信登录功能

# 😱 糟糕的 commit(完全看不懂)
修复bug

类型速查表(记不住也没关系,AI 会帮你):

你做了什么 用什么类型 举个例子
🎉 加了新功能 feat feat(支付): 添加支付宝支付
🐛 修了个 bug fix fix(登录): 修复登录失败
♻️ 重构了代码 refactor refactor(用户): 优化用户模块
📝 改了文档 docs docs(readme): 更新安装说明
🎨 调了格式 style style(代码): 统一缩进

💡 小贴士:这些规则不用死记硬背,因为 AI 会帮你选!


第二步:创建 AI 的"工作手册"

就像给助手写工作流程

想象你雇了一个助手,你会给他一份工作流程说明书,对吧?

1. 先建个文件夹

bash 复制代码
# 在项目根目录执行(就是有 package.json 的那个文件夹)
mkdir -p .agent/workflows

💬 解释.agent 是 AI 编辑器的专属文件夹,workflows 存放工作流程。

2. 创建工作手册

创建一个文件:.agent/workflows/commit.md

💬 你可以这样做

  • 方法 1:用 VS Code 或任何编辑器新建文件
  • 方法 2:复制我下面提供的模板

📄 模板内容(复制粘贴即可):

markdown 复制代码
---
description: 生成中文 commit 信息
---

# 生成中文 Commit 信息 Workflow

嘿,AI!当我说 `/commit` 的时候,请帮我:

## 第 1 步:看看我改了什么

```bash
git status
git diff --cached
```

## 第 2 步:分析我的改动

- 改了哪些文件?
- 是新功能、修 bug、还是重构?
- 主要目的是什么?

## 第 3 步:确定改动类型和范围

根据分析结果,确定:

- type:改动类型(feat/fix/refactor 等)
- scope:影响范围(登录/支付/用户等)

## 第 4 步:生成规范的 commit

按照这个格式:

```
<类型>(<范围>): <简短描述>

<详细说明>
```

## 第 5 步:给我可以直接执行的命令

生成一个 `git commit -m "..."` 命令,让我直接复制执行。

## 示例

**简单的:**

```bash
feat(登录): 添加微信登录
```

**详细的:**

```bash
feat(登录): 添加微信登录功能

- 集成微信 OAuth 认证
- 添加用户信息同步
- 实现自动登录
```

## 注意事项

- 描述要用中文,简单明了
- 一次 commit 只做一件事
- 如果改动很多,建议详细说明

✅ 完成! 你已经给 AI 写好工作手册了!


🧪 测试一下

来,试试你的新玩具!

1. 创建一个测试改动

bash 复制代码
# 随便改点东西
echo "测试" > test.txt
git add test.txt

2. 在 AI 助手中输入

bash 复制代码
/commit

3. 看看 AI 的反应

AI 应该会说:

bash 复制代码
✅ 我看到你添加了 test.txt 文件
✅ 这看起来是一个文档改动
✅ 类型:docs
✅ 范围:test

4. AI 会生成

sql 复制代码
好的!为你生成了 commit 信息:

git commit -m "docs(test): 添加测试文档

- 创建测试文件 test.txt"

请复制上面的命令执行即可!

5. 清理测试文件

bash 复制代码
git reset HEAD test.txt
rm test.txt

✅ 完美!你的 AI 助手已经上岗了!


🎓 给新手的小贴士

常见问题 Q&A

Q: 我不会用 AI 编辑器怎么办?

A: 推荐使用 Antigravity(免费)或 Trae CN(免费),下载后直接用,就像用 VS Code 一样简单。

Q: 我输入 /commit 没反应?

A: 检查三点:

  1. 确认 .agent/workflows/commit.md 文件存在
  2. 重启一下 AI 编辑器
  3. 确认你用的编辑器支持 workflow(Antigravity/Cursor/Windsurf/Trae CN 都支持)

Q: 我们团队的规范不一样怎么办?

A: 直接修改 .agent/workflows/commit.md 文件,改成你们的规范就行!

Q: 能不能添加任务编号?

A: 可以!修改 workflow 文件,在格式中添加 <task-id> 部分即可。


🎉 总结

通过 AI Workflow,我们将 commit 规范从"团队约定"变成了"自动化流程":

  • 降低门槛:新人无需记忆复杂规范
  • 提高效率:AI 自动分析和生成
  • 保证质量:统一的格式和标准
  • 易于推广:一次配置,全团队受益

立即开始使用 /commit workflow,让你的团队 Git 历史从此告别混乱!


📚 相关资源

完整配置文件

本文使用的完整 workflow 配置文件已开源,可以直接使用:

📄 GitHub 地址: .agent/workflows/commit.md

你可以:

  • ✅ 直接复制使用
  • ✅ 根据团队需求修改
  • ✅ 提交 PR 贡献改进

支持的 AI 编辑器


相关推荐
m0_4711996322 分钟前
【场景】如何快速接手一个前端项目
前端·vue.js·react.js
榴莲CC43 分钟前
抗干扰LED数显屏驱动VK1624 数码管显示芯片 3线串行接口
前端
Tigger1 小时前
用 Vue 3 做了一套年会抽奖工具,顺便踩了些坑
前端·javascript·vue.js
天天扭码1 小时前
一文搞懂——React 19到底更新了什么
前端·react.js·前端框架
weixin_462446231 小时前
【原创】使用langchain与MCP 与 Chrome DevTools 打造可调用浏览器工具的 Chat Agent
前端·langchain·chrome devtools
OpenTiny社区1 小时前
OpenTiny 2025年度贡献者榜单正式公布~
前端·javascript·vue.js
OEC小胖胖1 小时前
08|Commit 阶段:副作用如何被组织、执行与约束
前端·react.js·前端框架·react·开源库
奋斗的小青年!!1 小时前
Flutter跨平台开发OpenHarmony应用:个人中心实现
开发语言·前端·flutter·harmonyos·鸿蒙
kkce1 小时前
域名CDN检测意义
服务器·前端·网络
ZoeLandia2 小时前
Qiankun 生命周期与数据通信实战
前端·微前端·qiankun