CONTRIBUTING.md

Contributing

感谢你愿意改进这个教程仓库。这个项目以“源码学习笔记 + 工程化教程”为主，贡献重点是提高准确性、可读性和可维护性。

可以贡献什么

• 修正教程中的事实错误、链接错误、错别字或格式问题
• 补充 OpenCode 源码路径、调用流程、配置示例
• 为已有章节补充更清晰的图示、表格或实践步骤
• 提议新的教程主题或重排阅读路径

内容原则

• 尽量保持教程聚焦 OpenCode 的真实实现，不泛化成宽泛概念介绍。
• 涉及源码路径时，优先写出明确文件路径和函数/类型名。
• 大段新增内容需要说明依据，例如对应源码位置、官方文档或可复现实验。
• 不要提交私钥、token、内部项目路径或无法公开的截图。

Pull Request 流程

1. 从 main 创建分支。
2. 修改文档并确保相对链接有效。
3. 如果移动或重命名文档，同步更新 README.md 和 docs/README.md。
4. 提交 PR，并在描述中说明修改范围、验证方式和是否影响阅读路径。

文档格式

• Markdown 文件使用 UTF-8 和 LF 行尾。
• 标题层级保持清晰，避免跳级。
• 代码块尽量标注语言，例如 typescript、json、bash。
• 文件名使用小写 kebab-case，例如 01-system-prompt.md。