用途
git-conventions 是一套 Git 协作约定,用于规范分支命名、提交信息(commit message)和拉取请求(PR)的写法。它适用于创建分支、撰写提交信息、发起 PR,以及决定 PR 目标分支等场景。
主要能力
分支命名
- 关联 JIRA 工单:
<jira-key>/<descriptive-slug>,例如ag-12345/fix-tooltip-flicker。 - 无 JIRA 工单:
<initials>/<descriptive-slug>,例如at/improve-watch-reload-time。 - 发布分支:
b12.0.0(参见 releases skill)。 - slug 使用 kebab-case。JIRA 键的大小写灵活,
ag-12345与AG-12345均可使用。 - 多个工单:在 slug 之前用下划线连接,例如
CRT-1030_CRT-1044/fix-highlight。
提交信息
- 首行:
AG-XXXX <description>(JIRA 键大写,使用祈使语气)。键后加冒号也可接受:AG-XXXX: <description>。 - 无 JIRA:
<description>(使用祈使语气)。 - 首行保持在 72 个字符以内。
- 多行提交:首行之后空一行,然后写正文段落或要点,用于补充上下文。
- 绝不标注智能体工具(不要出现 "Co-authored-by"、"Generated by" 或类似内容)。
拉取请求(PR)
- 目标分支:
latest(默认分支,不是 main 或 master)。仅当工作针对某个发布时,才以bX.Y.Z发布分支为基。 - 标题:关联 JIRA 时写
AG-XXXX <description>,否则写普通描述。标题在 70 个字符以内。 - 多个工单:用逗号分隔键,例如
CRT-1030, CRT-1044 Fix highlight。 - 正文(关联 JIRA):给出 JIRA 工单链接。仅当变更需要超出工单本身的解释时,才补充上下文。
- 正文(无 JIRA):简明描述该变更。
- 描述保持简洁——这是一个公开仓库。
- 绝不标注智能体工具。
使用方式
在创建分支、撰写提交信息、发起 PR 或选择 PR 目标分支时,按上述规则执行即可。规范本身以文本约定形式提供,未提供安装命令或代码。
适用场景
适用于使用 JIRA 跟踪任务、需要统一 Git 协作流程的软件开发团队,尤其是公开仓库的贡献流程。
限制
资料未提供该规范的自动化校验工具、安装方式、收费信息或平台支持范围,这些内容暂未提供。