你有没有遇到过这种场景:
PR 已经发了、代码也改完了,唯一的问题是 commit message 呃……真的不好读。
比如团队里最常见、也最让人抓狂的写法(说重一点:狗屎一样的 commit):
fix: 修复了已知问题fix: 修复bugperf: 优化页面style: 更新样式chore: 更新了部分逻辑它们的问题不是“写错了”,而是几乎没有信息密度:读起来像一句句屁话。
对写的人来说可能“看一眼就知道发生了什么”。但对没参与实现的人来说,只会变成一句更大的问号:到底解决了什么问题?影响哪里?为什么要改?
很多 commit 的“可读性”不足,并不是因为你不够努力,而是因为你在写的时候更像是在描述代码变更,而不是在传达意图。
更现实的原因通常是这两个:
非技术读者(或未来的自己)通常需要的是:
workpilot 想解决的,就是把这件事从“靠脑子写”变成“基于 diff 自动生成”。
workpilot 是一个 AI CLI,会读取你本地 Git 历史与代码 diff,并生成可直接分享的内容。
在“生成 commit message”这个场景里,你只需要:
wp commit它的输出遵循常见的规范 commit message 结构,让 summary 更像“给人看的结论”,而不是“给机器的操作记录”。
wp commit 的推荐输出格式是:
text 体验AI代码助手 代码解读复制代码<type>[scope]: <summary>
<optional body>其中:
summary:一句话说明改动目的(不罗列文件、不描述实现细节),通常控制在 72 字符以内body(可选):最多 3 行,用来补充关键背景或影响type 常用值:feat / fix / refactor / perf / docs / test / build / ci / style / chore在你的项目里:
bash 体验AI代码助手 代码解读复制代码wp commit它会根据你当前仓库的 diff 生成 commit message,并引导你确认是否执行 git add -A以及是否git commit。
如果你只想先看效果,不急着提交:
bash 体验AI代码助手 代码解读复制代码wp commit --no-commitgit add 的内容)bash 体验AI代码助手 代码解读复制代码wp commit --stagedbash 体验AI代码助手 代码解读复制代码wp commit --workbash 体验AI代码助手 代码解读复制代码wp commit --no-commitbash 体验AI代码助手 代码解读复制代码wp commit copy
wp commit --no-commit copytext 体验AI代码助手 代码解读复制代码fix: 修复了已知问题问题是:它没有告诉人“目的是什么”和“影响哪里”。
text 体验AI代码助手 代码解读复制代码fix(ui): 修复列表异常展示,减少用户操作中断这类写法的核心变化是:
scope 标明主要影响模块(例如 ui)summary 讲清“解决什么 + 带来什么改善”当 commit message 变得可读,你会同时获得三件事:
对开发者来说,这不是“好看”,是减少沟通成本。
bash 体验AI代码助手 代码解读复制代码wp commit --no-commitbash 体验AI代码助手 代码解读复制代码wp commit(交互确认后再提交)
链接:http://cdy.my.canvaite.cn/ http://cdbd.my.canvaite.cn/ http://cdcw.my.canvaite.cn/
安装:
bash 体验AI代码助手 代码解读复制代码npm i -g workpilot帮助:
bash 体验AI代码助手 代码解读复制代码wp --helpcommit message 的价值不在于记录代码动作,而在于传递改动意图。
如果你也不想再写那种别人看完只会“嗯?”的 commit——从今天开始试试 wp commit。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。