# 贡献指南

感谢你愿意一起把 CodexGuide 做成面向全球初学者、创作者、开发者与团队的 Codex 实践指南。

## 内容原则

- 优先准确，再追求完整。
- 教程要可复现：尽量给出环境、命令、输入、预期结果和常见失败原因。
- 区分“官方事实”和“个人经验”。官方事实请附来源链接，经验内容请说明适用场景。
- 避免复制大段官方文档。请用自己的语言解释、重组和补充实践上下文。
- 不收录破解、绕过权限、泄露密钥或侵犯他人代码权益的内容。

## 推荐贡献类型

- 修正文档错别字、过时链接和不准确表述。
- 新增一个 Codex 实战案例，放在 `docs/recipes/`。
- 补充排障条目，放在 `docs/guide/18-troubleshooting.md`。
- 增加团队协作模板，例如 `AGENTS.md` 模板、PR 描述模板、任务说明模板。
- 同步官方文档变化，并在相关页面更新最后核对日期。

## 本地开发

```bash
pnpm install
pnpm dev
```

提交前请运行：

```bash
pnpm build
```

## 文档写作格式

- 每篇文章开头写清楚读者会获得什么。
- 命令使用 fenced code block。
- 文件名、配置项、模型名、命令参数使用反引号。
- 涉及时间敏感信息时写明核对日期。
- 面向新手时先解释背景，再给命令。

## Pull Request

PR 描述建议包含：

- 改了什么
- 为什么需要改
- 如何验证
- 是否涉及官方资料更新

如果你新增案例，请尽量附上最小复现仓库、关键命令输出或截图。