Codex 提交信息技能:按 Conventional Commits 补全正文和 Issue 引用
EnglishCodex 安装步骤
- 打开 GitHub 固定提交的 `.agents/skills/commit-message-writer/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.agents/skills/commit-message-writer/`,把核对后的文件保存为 `.agents/skills/commit-message-writer/SKILL.md`。
- 在该项目根目录启动 Codex,输入 `$commit-message-writer` 并选择同名技能。
中文摘要
从用户提供的一段 Git 改动起草规范的提交信息,每次都包含带模块的标题、说明正文和末行 Issue 引用。
SKILL.md 中文导读
可复现示例
根据以下模拟改动写一条 Git 提交信息。Issue 只用于关联。
{"type":"docs","scope":"onboarding","change":"document the sample data location","reason":"new contributors could not find the demo input","issue":317}工作步骤
- 根据改动类型和模块确定 Conventional Commits 提交标题,英文标题用动词开头并控制在 72 字符内。
- 写至少一句正文,说明改动及其原因,正文与标题之间留一行空白。
- 末行补上 Issue 引用并核对编号,例如使用 Refs 表示关联。
验收方法
第一行用 `docs(onboarding): document the sample data location`。空一行后写出新贡献者找不到演示输入这一原因,末行放 `Refs #317`。
GitHub 原文 · 更新日期
适用环境
在 Codex 打开项目,准备要提交的改动摘要或差异片段,并提供对应 Issue 编号。该演示技能只需这些文本材料即可练习。
常见问题
Codex 提交信息里的 Issue 引用可以放进标题吗?
按这套 Conventional Commits 工作流,把 Issue 引用放在最后一行。这样正文仍然能清楚说明改动原因。