用途:为 Git 提交、PR 和发布说明生成符合 CockroachDB 约定的文本,适用于提交变更或创建 PR 时。
主要能力:先读取项目特定规则(如有),收集变更上下文(git status -sb、git diff --stat、git diff),判断主要变更类型,仅追问缺失输入(改了什么及原因、是否破坏性变更、发布说明需求与受众及分类、Issue/Epic/Tracking 引用),再产出并校验文本。
提交格式:type: Subject,type 建议为 feat、fix、docs、style、refactor、test、chore、revert。主题行规则:与正文空一行、不超过 50 字符、首字母大写、不以句号结尾、使用祈使语气。正文说明 what 与 why,不写 how,每行 72 字符(硬上限 100),英文祈使语气。破坏性变更使用 type!: Subject 或页脚 BREAKING CHANGE: ...;仅在项目使用引用时添加 Issue 引用(如 Refs: #123)。
PR:标题为简短祈使短语、无句号;描述回答改了什么、为什么、是否有破坏性变更,可复用提交主题。
发布说明:只含面向用户的变更;内部重构、测试、基础设施使用 Release notes: None;分类可用 Added / Changed / Fixed / Breaking / Security / Performance;说明改了什么、为何重要、用户如何感知。
输出模板包含 Commit、PR、Release notes 三类。校验清单:主题长度不超过 50、祈使、首字母大写、无句号;主题与正文间空行;正文每行 72(不超过 100);正文只解释 what/why;不得包含密钥或凭据。限制:需按给定输入与项目规则执行,未提供项目规则时无法套用特定约定。