Codex TopicLab Git 约定:按 PR 范围命名分支和提交
EnglishCodex 安装步骤
- 打开固定版本的 GitHub 原文,从该版本保留 `.codex/skills/git-commit-conventions/` 整个目录。将它放入目标项目的 `.agents/skills/git-commit-conventions/`。
- 在目标项目中打开 Codex,输入 `$git-commit-conventions` 并给出本页示例里的任务和所需输出。
中文摘要
按 TopicLab 工作副本的约定选择分支名、Conventional Commit 类型和范围。适合在创建 PR 前核对改动边界和作者信息。
SKILL.md 中文导读
可复现示例
在练习分支输入 `$git-commit-conventions`,提供一处 TopicLab 文档修复,要求给出适用的分支名与标题草稿。工作步骤
- 检查仓库状态、适用规则与近期历史,记录目标变更所属范围。
- 按实际变更内容拟分支名与英文提交标题,并检查拟暂存路径是否同属该工作。
验收方法
分支名和标题符合仓库局部约定,类型与文档改动匹配。草稿列出拟纳入的文件。
GitHub 原文 · 更新日期
适用环境
Codex 与 Tashan-TopicLab 工作副本。准备目标提交或当前差异、分支约定和相关 AGENTS.md。
常见问题
什么时候写 scope?
当改动明确属于某模块、应用或子系统时,选择能准确说明它的最小范围。