先把差异缩小,再谈措辞

提交说明应描述这次实际提交的改动,而不是把整周的工作都写进去。让 ChatGPT 帮忙之前,先运行 git diff --cached 核对已暂存的差异;未暂存文件和未跟踪文件不在本次提交里。不要把含密钥、用户数据或内部地址的差异原样贴给外部工具。下面的文件名和改动纯属自拟示例,未执行真实项目的提交。

Git提交说明教学图:从已暂存差异提取动词、对象、范围,再核对原因、测试声明和敏感信息。
自拟报名表提交示例;是否测试通过和实际提交文件由仓库记录决定。查看大图 ↗

一次小改动如何落到一句标题

假设已暂存差异只有两处:在报名表中给邮箱输入框增加可见标签;在表单测试里补一个“点击标签会聚焦邮箱”的检查。标题可以写“为报名邮箱字段补充可见标签与焦点测试”。它陈述了行为和范围,没有写“全面提升无障碍体验”这种尚未由两行代码证明的结论。

若团队习惯英文或固定前缀,按项目规则改写。Git 官方文档建议先用简短首行概括变更,必要时空一行写更详细的说明;具体字数只是编辑建议,不是 Git 强制规则。正文可以解释原因:“此前邮箱字段只有占位文字;本次补上标签关联,便于理解字段用途。”如未真正运行测试,应写“新增测试用例”,不能写“所有测试通过”。

用检查项约束模型

提示词要求它只依据给出的暂存差异,列出动词、对象、影响范围,并标出无法从差异验证的断言。让它输出一个短标题和可选的两句正文,不要自动生成版本号、修复单号或性能收益。再人工对照 diff:若发现标题覆盖了未提交文件,删掉那部分。

提交前仍由人决定

模型不能替你决定哪些文件应暂存。提交前再看 git status 与 git diff --cached --stat,确认没有凭据、临时截图或无关改动。团队若有签名、关联任务、提交格式要求,也按仓库规定执行。本文只教写说明和核对证据,不会在读者仓库中实际创建提交。