Skip to content

Conversation

@CodeCasterX
Copy link
Member

🔗 相关问题 / Related Issue

Issue 链接 / Issue Link:

  • 我已经创建了相关 Issue 并进行了讨论 / I have created and discussed the related issue
  • 这是一个微小的修改(如错别字),不需要 Issue / This is a trivial change (like typo fix) that doesn't need an issue

📋 变更类型 / Type of Change

  • 📚 文档更新 / Documentation update
  • 🚀 功能增强 / Feature enhancement (improve existing functionality without breaking changes)

📝 变更目的 / Purpose of the Change

为 Codex CLI 完善项目级 prompts 配置,包括:

  1. 格式标准化:将所有 Codex prompts 迁移到官方规范的混合格式
  2. 功能完整性:补全所有任务管理相关的命令文档
  3. 配置优化:修复插件引用问题,确保 Codex CLI 正常工作
  4. 文档完善:添加完整的格式规范说明和使用指南

📋 主要变更 / Brief Changelog

1. Codex Prompts 格式迁移(混合格式)

  • 移除冗余字段:删除 name 字段(文件名即为 prompt 名称)
  • 保留完整文档:保留 usage 字段提供完整使用示例
  • 符合官方规范:添加 argument-hint 字段(Codex 官方格式)
  • 统一编码:去除所有字段值的双引号

示例格式

---
description: 分析 GitHub Issue 并创建需求分析文档
usage: /prompts:analyze-issue <issue-number>
argument-hint: <issue-number>
---

2. 新增/完善命令文档(17个命令)

任务管理

  • analyze-issue - 分析 GitHub Issue 并创建需求分析文档
  • plan-task - 为任务设计技术方案并输出实施计划
  • implement-task - 根据技术方案实施任务并输出实现报告
  • review-task - 审查任务实现并输出代码审查报告
  • refinement-task - 处理代码审查反馈并修复问题
  • complete-task - 标记任务完成并归档到 completed 目录
  • task-status - 查看任务的当前状态和进度
  • block-task - 标记任务阻塞并记录阻塞原因

Git 操作

  • commit - 提交当前变更到 Git(提供最佳实践指南)
  • create-pr - 创建 Pull Request
  • sync-pr - 将任务处理进度同步到 Pull Request 评论
  • sync-issue - 将任务处理进度同步到 GitHub Issue 评论
  • refine-title - 深度分析 Issue 或 PR 内容并重构标题

依赖和安全

  • upgrade-dependency - 升级项目依赖
  • analyze-security - 分析 Dependabot 安全告警并创建修复任务
  • close-security - 关闭 Dependabot 安全告警

其他

  • test - 执行完整的测试流程

3. 配置文件优化

  • 修复插件引用:移除 Codex CLI 不支持的 Claude Code 插件引用
  • 添加安装脚本install-prompts.sh 支持一键安装到用户目录
  • 完善 README:添加格式规范、使用指南和 Claude Code 对比说明

4. Claude Code 同步更新

  • .claude/commands/ 下的 commit.mdtest.md 添加 YAML frontmatter
  • 删除已废弃的 fix-permissions.md(功能已迁移到技能)

🧪 验证变更 / Verifying this Change

测试步骤 / Test Steps

  1. 验证格式正确性

    # 检查所有文件的 frontmatter
    for file in .codex/commands/*.md; do
      head -7 "$file"
    done
  2. 验证安装脚本

    bash .codex/scripts/install-prompts.sh
    # 确认所有 17 个命令正确安装并显示描述
  3. 验证格式解析

    • 确认 description 字段正确提取(无引号)
    • 确认命令列表正确显示

测试覆盖 / Test Coverage

  • 所有现有测试都通过 / All existing tests pass
  • 我已经进行了手动测试 / I have performed manual testing

测试结果

  • ✅ 安装脚本运行成功,所有命令正确安装
  • ✅ 格式解析正确,description 正确提取
  • ✅ 所有 17 个命令文档完整且格式统一

✅ 贡献者检查清单 / Contributor Checklist

基本要求 / Basic Requirements:

  • 确保有 GitHub Issue 对应这个变更(微小变更如错别字除外)
  • 你的 Pull Request 只解决一个 Issue,没有包含其他不相关的变更
  • PR 中的每个 commit 都有有意义的主题行和描述

代码质量 / Code Quality:

  • 我的代码遵循项目的代码规范
  • 我已经进行了自我代码审查
  • 我已经为复杂的代码添加了必要的注释

文档和兼容性 / Documentation and Compatibility:

  • 我已经更新了相应的文档
  • 如果有破坏性变更,我已经在 PR 描述中详细说明(无破坏性变更)
  • 我已经考虑了向后兼容性

📋 附加信息 / Additional Notes

混合格式的优势

此次格式迁移采用混合方案,平衡了以下需求:

  1. 官方标准合规:包含 argument-hint 字段,符合 Codex 官方文档
  2. 文档完整性:保留 usage 字段,提供完整的使用示例
  3. 减少冗余:删除 name 字段,避免重复维护
  4. 谨慎迁移:不完全放弃现有格式,保持向后兼容性

安装和使用

# 安装所有 prompts 到用户目录
bash .codex/scripts/install-prompts.sh

# 使用示例
/prompts:analyze-issue 123
/prompts:commit
/prompts:test

与 Claude Code 的区别

.codex/ 配置为 Codex CLI 专用,与 .claude/ 的主要区别:

  • 无插件系统:Codex CLI 不支持 Claude Code 的官方插件
  • 调用格式:使用 /prompts:command-name 而非 /command
  • 文档导向:提供详细的操作步骤和检查清单

详细对比见 .codex/README.md


审查者注意事项 / Reviewer Notes:

  1. 重点检查 YAML frontmatter 格式是否符合 Codex 规范
  2. 确认所有命令文档的完整性和准确性
  3. 验证安装脚本在不同环境下的兼容性

🤖 Generated with Claude Code

CodeCasterX and others added 8 commits January 16, 2026 11:28
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
移除对 Claude Code 插件的无效引用,确保 Codex CLI 命令可正常使用。

主要修改:
- commit.md: 删除 commit-commands 插件引用,添加完整的 Git 操作步骤
- review-task.md: 标记 code-review 和 pr-review-toolkit 为 Claude Code 专用
- implement-task.md: 更新命令引用为 /prompts:xxx 格式
- sync-issue.md: 更新命令引用为 Codex CLI 格式
- README.md: 添加与 Claude Code 区别说明和常见问题解答

修复内容:
- 所有命令不再依赖不存在的 Claude Code 插件
- 使用正确的 /prompts:command-name 调用格式
- 提供清晰的手动操作步骤和检查清单
- 明确区分 Codex CLI 和 Claude Code 的功能差异

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
为所有命令文件补充 YAML frontmatter,改进安装脚本用户体验。

主要修改:
- 为 commit.md 和 test.md 添加 YAML frontmatter(Claude 和 Codex)
- 删除 fix-permissions.md(已不再使用)
- 改进 install-prompts.sh:显示完整命令列表和描述

改进内容:
- 统一所有命令文件的元数据格式
- 安装脚本自动提取并显示所有命令描述
- 明确显示安装的命令数量和覆盖提示
- 提供更友好的输出格式

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- 移除冗余的 name 字段(文件名即为 prompt 名称)
- 去除所有字段值的双引号
- 保留 usage 字段(提供完整的使用示例)
- 添加 argument-hint 字段(符合 Codex 官方格式)
- 在 README 中添加完整的格式规范文档

此混合格式既符合 Codex 官方规范,又保留了文档完整性。

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@CodeCasterX CodeCasterX requested review from a team and loveTsong and removed request for a team January 16, 2026 08:47
@CodeCasterX CodeCasterX self-assigned this Jan 16, 2026
@CodeCasterX CodeCasterX added type: documentation A documentation task in: fit Issues in FIT modules labels Jan 16, 2026
@CodeCasterX CodeCasterX added this to the 3.6.3 milestone Jan 16, 2026
@CodeCasterX CodeCasterX changed the base branch from main to 3.6.x January 16, 2026 08:47
@CodeCasterX CodeCasterX merged commit 530cf1b into 3.6.x Jan 16, 2026
9 checks passed
@CodeCasterX CodeCasterX deleted the fit-enhancement-codex-slash-command branch January 16, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in: fit Issues in FIT modules type: documentation A documentation task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants