用途:帮助用户按 CockroachDB 约定创建格式规范的提交信息、发布说明(release note)和 PR。
主要能力与工作流:先运行 git diff --staged 或 git diff 分析改动,确定受影响的包前缀;向用户询问 issue/epic 编号、是否需要发布说明及合适类别;撰写祈使语气、无句号、72 字符以内的主题行;正文说明改动前后与原因;添加 Resolves/Epic 引用;撰写面向用户的发布说明;最后用格式化信息创建提交。
提交信息结构:主题行格式为“package: 祈使标题(无句号)”,与正文之间空一行;正文解释改了什么、为何改、对用户的影响,可提及备选方案与副作用;包含 Resolves: #123、Epic: CRDB-357 等引用;发布说明格式为“Release note (category): 描述”。
关键要求:必须包含发布说明标注(即使为 Release note: None);必须包含 issue 或 epic 引用;主题与正文用空行分隔;建议主题加包/区域前缀、使用祈使语气、正文按 72-100 字符换行。
发布说明类别:backward-incompatible change、enterprise change、ops change、cli change、sql change、ui change、security update、performance improvement、cluster virtualization、bug fix、general change、build change。用户交互、产品行为、影响外部用户的 bug 修复需写发布说明;内部重构、测试、基础设施、crdb_internal. 设置、外部用户不可访问的功能可省略。
PR 指南:从个人 fork 创建,不要直接在 cockroachdb/cockroach 上创建;单提交 PR 的标题与正文应与提交一致;多提交 PR 正文应总结整体目标并提供逐提交审阅所需上下文。
限制:资料未提供安装方式、平台支持、收费信息或自动化程度等细节。