Claude写Git提交说明时提示词需要哪些背景信息

作者:技术拾光

时间:2026-06-03

浏览:90

为让Claude生成有效Git提交说明,提示词需包含:技术栈(如Vue3+TypeScript+Pinia)、精确业务域(如订单中心优惠券校验)、最近相关提交信息、代码变更(推荐直接给diff或提炼改动原因影响),并严格按ConventionalCommits格式限定type、中文业务名、单语义及28字内subject。

文章目录

写好Git提交说明,这事儿真不是敲两行字那么简单

尤其是当这部分工作交给AI去处理的时候——如果提示词里没有塞进真实的项目上下文,那出来的东西八成是“修复bug”“优化性能”这种看了跟没看一样的废话。所以关键在于,怎么让Claude理解你到底改了什么。

第一步:明确技术栈上下文

如果团队用的是Vue 3 + TypeScript + Pinia这套技术栈,你却不告诉它,它可能会默认用React Hooks那一套语法来写描述,甚至把Pinia store当成Redux slice来称呼。所以第一步必须明确:这是一个基于Vue 3 + TypeScript + Pinia的管理后台,用Vite构建,API通信靠axios封装的request模块。没有这句话,上下文就断了。

第二步:细化业务域

光有技术栈还不够。你要是只说“跟订单有关”,Claude大概率会按文件路径去猜scope,结果出来一个src/views/order/OrderConfirm.vue——这谁看得懂?所以必须精确到业务域,比如“本次修改属于【订单中心】模块,涉及用户下单流程中的优惠券选择与校验环节”。越具体,生成的说明越能直达要害。

第三步:提供最近一次相关提交信息

还有一个很多人会忽略的细节:最近一次相关提交的信息。比如“上一次对同一逻辑的修改是3天前的提交 a1b2c3d:fix(优惠券): 修复满减门槛未生效问题”。这能帮Claude理解演进脉络,避免它写出自相矛盾的描述。毕竟它没有记忆,靠的就是你给的那点信息。

第四步:明确代码变更细节

代码变更是最核心的部分。这里有两个办法。一个是直接把diff片段扔进去——比如把git diff --no-index的结果贴到提示词里,Claude就能准确提取出“删除了checkEligibility函数中对couponId === null的兜底判断”这个事实。另一个办法是自己提炼三要素:改了什么、为什么改、影响范围。比如“【改了什么】删除useCoupon.ts中checkEligibility函数内对couponId === null的手动判空;【为什么改】后端已保证couponId必传,该判断冗余且干扰错误定位;【影响范围】仅影响前端优惠券选择后的实时校验”。这两个方法里,我最推荐第一个,因为细节更准确、可控性更高。 Claude写Git提交说明时提示词需要哪些背景信息

第五步:严格遵循中文Conventional Commits格式

最后是提交格式的硬杠杠。严格按中文Conventional Commits格式来:type统一用feat、fix、refactor、chore这几个,括号里写中文业务名,比如(优惠券)(订单列表)。禁止出现文件名、类名、技术术语,也不准写“优化代码”“提升可维护性”这种说了等于没说的话。还有一个头疼的问题:AI喜欢用顿号并列多个改动。这不行,一个提交只对应一个语义,多个改动就拆多个提交。subject长度也不能超过28个汉字,塞不下的就截断加省略号,不许换行。这几点看着严格,但实际用下来你会发现,它逼着人类作者自己先把逻辑想清楚,反而省了很多返工的时间。

实用工具推荐

电子包浆

绿化、压缩、噪点和虚拟水印,自由调节做旧程度。

使用 ›
图片压缩

选择画质和输出格式,预览压缩前后的大小。

使用 ›
相关文章