Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
196 lines (134 loc) · 4.48 KB

CONTRIBUTING.md

File metadata and controls

196 lines (134 loc) · 4.48 KB

贡献指南

首先，感谢你愿意为 AgentGuide 贡献力量！🎉

🌟 贡献方式

1. 内容贡献

新增文档

  • 选择一个还未完成的章节（README 中标记为 [ ] 的部分）
  • 按照统一的文档模板编写内容
  • 确保内容系统、深入、实用

文档模板

# 章节标题

## 📌 本节目标

- 学习目标 1
- 学习目标 2
- 学习目标 3

## 💡 核心概念

（用通俗易懂的语言解释核心概念）

## 🔍 深入理解

（详细展开，配合代码示例、图表）

## 💻 代码示例

（提供完整可运行的代码）

## 🎯 面试中如何考

（列出相关的面试题和回答思路）

## 📚 扩展阅读

- 论文链接
- 优质博客
- 相关项目

2. 代码贡献

示例代码规范

  • 代码必须可以直接运行
  • 添加详细的注释
  • 提供 requirements.txt
  • 在代码开头说明运行环境和依赖版本

项目代码规范

  • 遵循 PEP 8 编码规范
  • 使用有意义的变量名
  • 关键逻辑必须有注释
  • 复杂函数需要添加 docstring

3. 问题反馈

发现以下问题请提 Issue：

  • 文档错误（错别字、技术错误）
  • 代码 Bug
  • 内容缺失
  • 改进建议

🚀 贡献流程

Step 1: Fork 项目

点击页面右上角的 Fork 按钮，将项目 Fork 到你的 GitHub 账号。

Step 2: 克隆到本地

git clone https://github.com/你的用户名/AgentGuide.git
cd AgentGuide

Step 3: 创建分支

# 内容贡献
git checkout -b docs/add-langchain-guide

# 代码贡献
git checkout -b feat/add-rag-example

# Bug 修复
git checkout -b fix/typo-in-readme

Step 4: 进行修改

  • 编写文档或代码
  • 确保符合规范
  • 本地测试通过

Step 5: 提交修改

git add .
git commit -m "docs: 新增 LangChain 核心概念文档"
# 或
git commit -m "feat: 新增 RAG Agent 示例代码"
# 或
git commit -m "fix: 修复 README 中的错别字"

Commit Message 规范：

  • docs: 文档相关
  • feat: 新增功能/内容
  • fix: 修复问题
  • style: 格式调整
  • refactor: 代码重构

Step 6: 推送到 GitHub

git push origin 你的分支名

Step 7: 提交 Pull Request

  1. 在 GitHub 上打开你 Fork 的仓库
  2. 点击 Pull Request 按钮
  3. 填写 PR 描述，说明你做了什么改动
  4. 提交 PR，等待审核

✅ PR 审核标准

你的 PR 需要满足以下条件才会被合并：

文档类 PR

  • ✅ 内容准确，无明显技术错误
  • ✅ 语言通顺，排版清晰
  • ✅ 符合文档模板规范
  • ✅ 包含代码示例和面试考点（如适用）

代码类 PR

  • ✅ 代码可以正常运行
  • ✅ 符合编码规范
  • ✅ 有足够的注释
  • ✅ 提供了 requirements.txt 或说明依赖

Bug 修复类 PR

  • ✅ 清楚地说明了修复的问题
  • ✅ 测试通过

🎁 贡献者权益

凡是为项目贡献内容的小伙伴，将会：

  1. 名字出现在贡献者列表：在 README 和致谢页面永久展示
  2. 优先获得作者的技术支持：可以优先向作者请教问题
  3. 专属贡献者身份：在社群中获得"核心贡献者"标识
  4. 优质内容推荐：优秀的贡献内容会通过公众号/小红书推广

📝 内容认领机制

为了避免重复劳动，请在开始编写前：

  1. 在 Issues 中创建一个新 Issue
  2. 标题格式：[认领] 章节名称，如 [认领] LangChain 核心概念与实战
  3. 说明你的计划和预计完成时间
  4. 等待作者回复确认后再开始

❓ 常见问题

Q1: 我是新手，不知道从哪里开始？

A: 推荐从以下几个方向开始：

  • 纠正文档中的错别字或格式问题
  • 完善代码示例的注释
  • 补充"扩展阅读"部分的优质资源链接

Q2: 我想贡献内容，但不确定写得对不对？

A: 没关系！提交 PR 后，我会仔细 Review 并给出建议。不用担心犯错，一起改进就好。

Q3: 我可以翻译成英文吗？

A: 当然可以！英文版的建立会让更多人受益。请先在 Issue 中说明你的计划。

💬 联系方式

如果你有任何疑问，可以通过以下方式联系作者：

再次感谢你的贡献！让我们一起打造 AI Agent 领域最好的中文学习资源！🚀