关于 commit
用于创建 Git 提交的 Codex skill,依据会话意图和暂存的更改撰写符合常见规范的提交信息。
主要功能
- 01检查会话背景与 Git 更改
- 02暂存目标文件并核对范围
- 03采用常见提交主题格式
- 04写入摘要、理由和验证情况
- 05添加 Codex 共同作者标记
适用场景
- 01提交已完成的编码会话
- 02检查暂存文件是否包含无关更改
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openai/ symphony --skill commit安装后在 Claude Code 中输入/commit确认已加载。
详细介绍
提交
目标
- 创建一个能反映实际代码变更和会话背景的提交。
- 遵循常见的 Git 约定(类型前缀、简短主题、正文换行)。
- 在正文中同时说明概要和原因。
输入
- Codex 会话历史,用于了解意图和原因。
git status、git diff和git diff --staged,用于了解实际变更。- 仓库中记录的专属提交约定(如有)。
步骤
- 阅读会话历史,确定范围、意图和原因。
- 检查工作树和暂存的变更(
git status、git diff、git diff --staged)。 - 确认范围后,暂存预期变更,包括新文件(
git add -A)。 - 检查新添加的文件是否合理;如果发现可疑内容或可能应被忽略的文件 (构建产物、日志、临时文件),请在提交前告知用户。
- 如果暂存不完整或包含无关文件,请修正索引或征求确认。
- 选择与变更匹配的常规类型和可选范围(例如:
feat(scope): ...、fix(scope): ...、refactor(scope): ...)。 - 使用祈使语气编写主题行,不超过 72 个字符,末尾不加句号。
- 编写正文,包含:
- 关键变更概要(改了什么)。
- 原因和权衡(为什么要改)。
- 运行的测试或验证(如果未运行,请明确说明)。
- 除非用户明确要求使用其他身份,否则为 Codex 追加
Co-authored-by声明,使用Codex <[email protected]>。 - 正文每行不超过 72 个字符。
- 使用 here-doc 或临时文件创建提交消息,并通过
git commit -F <file>提交,以确保换行符按原样保留 (避免使用包含\n的-m)。 - 仅当提交消息与暂存的变更一致时才提交:如果暂存差异包含无关文件, 或消息描述了尚未暂存的工作,请修正索引或修改消息。
输出
- 使用
git commit创建一个能反映本次会话的提交。
模板
类型和范围仅为示例;请根据仓库和变更进行调整。
<type>(<scope>): <short summary>
Summary:
- <what changed>
- <what changed>
Rationale:
- <why>
- <why>
Tests:
- <command or "not run (reason)">
Co-authored-by: Codex <[email protected]>
评论
支持 Markdown