这是一个用于存放可复用 Codex skills 的仓库,当前主要覆盖工程文档治理、git commit 摘要生成,以及 skill 质量评审。
目标: 建立和治理一套稳定的工程文档体系,而不是零散的 Markdown 文件。
功能:
- 创建或扩展编号化的
docs/结构。 - 根据主题和范围判断文档应放置的位置。
- 约束主文档与补充文档的边界。
- 支持遗留文档重命名的规划、执行与回滚。
- 提供常见文档流程所需的模板和辅助脚本。
适用场景:
- 新项目需要建立文档体系。
- 工程文档规模较大或持续增长。
- 团队需要稳定编号规则和受控重命名流程。
入口:
目标: 基于真实本地 diff 生成符合仓库约定的 git commit 摘要。
功能:
- 先检查 staged 或 unstaged 变更,再生成提交摘要。
- 根据仓库约定调整提交格式,而不是凭文件名猜测。
- 在没有更强约定时,默认使用开源仓库格式
[module:type]: summary。 - 当提交规范信号不明确时,提供候选格式供用户选择。
- 生成简洁的 subject,并在需要时补充 body。
适用场景:
- 需要快速为当前改动生成提交摘要。
- 同时维护开源仓库和内部仓库,提交规范不一致。
- 当前改动混杂,需判断是否应拆分为多个提交。
入口:
目标: 用可复用、可追溯的方式评审 Codex skill,而不是给零散意见。
功能:
- 从结构、上下文效率、脚本安全、测试充分性、实用性等维度评分。
- 检查
SKILL.md、references、scripts、tests 和 agent metadata。 - 输出具体风险以及最短可行修复建议。
- 评估上下文窗口占用,输出字符数和粗估 token 数。
- 默认生成中文评分卡。
适用场景:
- 评审新建或修改后的 skill。
- 用统一 rubric 对比两个 skill。
- 提前发现上下文膨胀、脚本风险和测试缺口。
入口:
.
├── ivon-engineering-docs/
├── ivon-git-commit/
└── ivon-skill-quality/
每个 skill 通常包含:
SKILL.md:主入口。references/:按需加载的补充说明。agents/openai.yaml:展示名和调用行为配置。- 可选的
scripts/、templates/、tests/。
在 Codex 请求中直接点名 skill,例如:
使用 $ivon-git-commit 为当前改动生成提交摘要
使用 $ivon-skill-quality 对这个 skill 评分
使用 $ivon-engineering-docs 创建一套编号化工程文档结构
- 本仓库的 skill 默认尽量保持主入口轻量,把细节下沉到
references/。 - 部分 skill 带有辅助脚本和测试,按需进入对应目录执行。