Contributing

欢迎贡献文档、示例、修正和学习路线建议。本仓库优先接受能提升学习效率和内容可信度的改动。

优先贡献方向

• 修复错别字、失效链接、错误代码。
• 给 LLM、RAG、Agent 章节补充最小示例。
• 给热门 AI 技术文章阅读板块补充高质量文章摘要。
• 增加“什么时候不用某技术”的边界说明。
• 补充评估方法、失败案例和排错经验。
• 将旧章节更新到当前主流写法。

内容要求

新增或大幅修改章节时，请尽量包含：

• 学习目标：读者学完后能做什么。
• 前置知识：需要先理解哪些概念。
• 最小流程：从输入到输出的最短路径。
• 常见坑：真实使用中容易错在哪里。
• 评估方式：如何判断结果是否变好。
• 参考资料：优先官方文档、论文、课程或成熟项目。

写作风格

• 用中文解释核心概念，保留必要英文术语。
• 少堆链接，多解释选择依据。
• 示例尽量短，优先展示关键结构。
• 不写容易过期的“最强模型”结论；如果必须写，请说明日期和来源。
• 不提交 API key、token、个人数据或私有业务数据。

提交 PR 前检查

请至少完成：

git status --short
python3 tools/check_local_links.py

如果修改了代码示例，请尽量运行对应脚本或 notebook 的关键单元。

如果补充 热门 AI 技术文章阅读，请使用 阅读条目模板，并确保文章来自一手资料、官方博客、论文、工程复盘或成熟开源项目。

Issue 建议

提 Issue 时请说明：

• 问题所在文件或章节。
• 期望改成什么。
• 为什么这会帮助学习者。
• 如果是外链失效，请给出替代链接。