🎨 style(markdown): format all markdown files with prettier
- 使用 prettier 格式化所有 markdown 文件 - prose-wrap: always, print-width: 80 - 保持代码块和表格格式 - 提升可读性和一致性 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,8 +1,12 @@
|
||||
# SKILLS
|
||||
|
||||
本文件定义:如何在仓库中落地与维护 **Codex CLI skills**(实验功能),并给出与本 Playbook(`docs/` + `.agents/`)配套的技能编写建议与内置技能清单。
|
||||
本文件定义:如何在仓库中落地与维护 **Codex CLI
|
||||
skills**(实验功能),并给出与本 Playbook(`docs/` +
|
||||
`.agents/`)配套的技能编写建议与内置技能清单。
|
||||
|
||||
> 提示:Codex skills 是“按用户安装”的(默认在 `~/.codex/skills`)。本仓库将 skills 以可分发的形式放在 `codex/skills/`,并提供脚本一键安装到你的 `CODEX_HOME`。
|
||||
> 提示:Codex skills 是“按用户安装”的(默认在
|
||||
> `~/.codex/skills`)。本仓库将 skills 以可分发的形式放在
|
||||
> `codex/skills/`,并提供脚本一键安装到你的 `CODEX_HOME`。
|
||||
|
||||
---
|
||||
|
||||
@@ -42,7 +46,8 @@ $CODEX_HOME/skills/<skill-name>/SKILL.md
|
||||
|
||||
## 3. 安装到本机(推荐)
|
||||
|
||||
本仓库已提供跨平台安装脚本(会把 `codex/skills/*` 复制到 `$CODEX_HOME/skills/`):
|
||||
本仓库已提供跨平台安装脚本(会把 `codex/skills/*` 复制到
|
||||
`$CODEX_HOME/skills/`):
|
||||
|
||||
- macOS/Linux:`sh scripts/install_codex_skills.sh`
|
||||
- PowerShell:`powershell -File scripts/install_codex_skills.ps1`
|
||||
@@ -58,7 +63,8 @@ sh scripts/install_codex_skills.sh
|
||||
sh scripts/install_codex_skills.sh style-cleanup code-review-workflow
|
||||
```
|
||||
|
||||
如果你的项目通过 `git subtree` vendoring 本 Playbook(推荐前缀 `docs/standards/playbook`),则在目标项目里执行:
|
||||
如果你的项目通过 `git subtree` vendoring 本 Playbook(推荐前缀
|
||||
`docs/standards/playbook`),则在目标项目里执行:
|
||||
|
||||
```bash
|
||||
sh docs/standards/playbook/scripts/install_codex_skills.sh
|
||||
@@ -90,9 +96,12 @@ sh docs/standards/playbook/scripts/install_codex_skills.sh
|
||||
把 skill 当作“可检索的工作流模块”,而不是长篇教程:
|
||||
|
||||
1. **边界清晰**:只写“仓库/组织特定”的流程、约束与验收标准;避免通用编程常识。
|
||||
2. **description 负责检索**:把团队常用说法(中英文同义词)写进 `description`,降低漏触发概率。
|
||||
3. **SOP 化**:建议包含 Inputs → Procedure → Output Contract → Success Criteria → Failure Handling。
|
||||
4. **渐进式披露**:主 `SKILL.md` 保持精炼;大段清单/模板放 `references/`,引用深度 ≤ 1。
|
||||
2. **description 负责检索**:把团队常用说法(中英文同义词)写进
|
||||
`description`,降低漏触发概率。
|
||||
3. **SOP 化**:建议包含 Inputs → Procedure → Output Contract → Success Criteria
|
||||
→ Failure Handling。
|
||||
4. **渐进式披露**:主 `SKILL.md` 保持精炼;大段清单/模板放
|
||||
`references/`,引用深度 ≤ 1。
|
||||
5. **高风险低自由度**:破坏性操作(删数据/重写历史/生产变更)默认先停下确认,并给回滚方案。
|
||||
|
||||
---
|
||||
@@ -104,7 +113,9 @@ sh docs/standards/playbook/scripts/install_codex_skills.sh
|
||||
- C++:`docs/cpp/code_style.md`、`docs/cpp/naming.md`、`docs/cpp/toolchain.md`
|
||||
- Python:`docs/python/style_guide.md`、`docs/python/tooling.md`、`docs/python/configuration.md`
|
||||
|
||||
若你的项目通过 git subtree 引入本 Playbook,常见路径为 `docs/standards/playbook/docs/...`;把上述 `docs/` 前缀替换为 `docs/standards/playbook/docs/` 即可。
|
||||
若你的项目通过 git subtree 引入本 Playbook,常见路径为
|
||||
`docs/standards/playbook/docs/...`;把上述 `docs/` 前缀替换为
|
||||
`docs/standards/playbook/docs/` 即可。
|
||||
|
||||
---
|
||||
|
||||
@@ -112,7 +123,8 @@ sh docs/standards/playbook/scripts/install_codex_skills.sh
|
||||
|
||||
位于 `codex/skills/`:
|
||||
|
||||
- `commit-message`:基于 staged diff 自动建议提交信息(`:emoji: type(scope): subject`)
|
||||
- `commit-message`:基于 staged
|
||||
diff 自动建议提交信息(`:emoji: type(scope): subject`)
|
||||
- `create-plan`:生成简明计划(适用于用户明确要求规划编码任务)
|
||||
- `code-review-workflow`:结构化代码评审(正确性/安全/性能/测试)
|
||||
- `style-cleanup`:整理代码风格(优先使用仓库既有 formatter/lint 工具链)
|
||||
@@ -121,7 +133,8 @@ sh docs/standards/playbook/scripts/install_codex_skills.sh
|
||||
- `defense-in-depth`:关键路径分层校验/多道防线
|
||||
- `bulk-refactor-workflow`:批量重构(安全做法 + 验证契约)
|
||||
- `document-workflow`:PDF/DOCX/PPTX/XLSX 文档工作流(带开源 fallback)
|
||||
- `pdf-workflow` / `docx-workflow` / `pptx-workflow` / `xlsx-workflow`:按格式拆分的文档子工作流
|
||||
- `pdf-workflow` / `docx-workflow` / `pptx-workflow` /
|
||||
`xlsx-workflow`:按格式拆分的文档子工作流
|
||||
- `verification-before-completion`:先验证再宣称完成(证据链优先)
|
||||
|
||||
---
|
||||
@@ -132,5 +145,6 @@ sh docs/standards/playbook/scripts/install_codex_skills.sh
|
||||
- 确认已启用 `[features] skills = true`
|
||||
- 确认 skill 已安装到 `$CODEX_HOME/skills/<name>/SKILL.md`
|
||||
- 重启 `codex`(skills 只在启动时加载)
|
||||
- 触发错:减少不同 skill 的 `description` 关键词重叠;让触发词更具体(语言/工具/目录名/流程名)。
|
||||
- 触发错:减少不同 skill 的 `description`
|
||||
关键词重叠;让触发词更具体(语言/工具/目录名/流程名)。
|
||||
- 启动报错:通常是 YAML frontmatter 不合法或字段超长;修复后重启即可。
|
||||
|
||||
Reference in New Issue
Block a user