跳转到主要内容
感谢你对 SimpleLLMFunc 的兴趣。无论你是修复 bug、补充文档、完善示例，还是实现新功能，我们都欢迎你的贡献。

​
贡献方式

如果你发现问题或有新功能建议，请先在 GitHub Issues 搜索是否已有相同内容。提交 Issue 时建议包含：
  1. 清晰的标题
  2. 详细的问题描述或需求背景
  3. 复现步骤和环境信息
  4. 如果可能，附上代码片段、日志或截图

​
开发流程

1

准备开发环境

确保本地已安装 Python 3.12+ 和 Poetry，并完成依赖安装。
2

同步最新代码

在开始工作前，先基于仓库最新代码创建分支，避免在过旧基础上开发。
3

实现功能并补充测试

为功能或修复编写必要的测试和文档，避免只改代码不补说明。
4

自查并提交 PR

确认测试通过、风格一致、文档已更新，再发起 Pull Request。
如果你的改动会影响用户使用方式、配置方法或示例代码，请同时更新对应文档页面。

​
开发环境设置

​
依赖项

  • Python 3.12 或更高版本
  • Poetry（推荐的依赖管理工具）

​
安装开发依赖

git clone https://github.com/NiJingzhe/SimpleLLMFunc.git
cd SimpleLLMFunc
poetry install

​
文档 i18n 工作流

Mintlify 文档国际化通过脚本同步 locale 页面结构。
  • 中文根目录页面仍然作为默认源文档
  • 目标语言页面生成到 mintlify_docs/<lang>/...
  • 可通过脚本批量同步 locale 页面和导航配置
  • 对尚未覆盖的片段，可以继续迭代补充翻译内容或翻译记忆
poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en

poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en \
  --source-lang zh_CN \
  --sync-pages

poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en \
  --source-lang zh_CN \
  --sync-pages \
  --translate

poetry run python scripts/translate_mintlify_docs.py \
  --target-lang en \
  --source-lang zh_CN \
  --write-docs-json
也可以直接使用批处理脚本： 
bash scripts/batch_translate_mintlify.sh
建议先跑一次不带 --translate 的 audit 或 --sync-pages，先确认页面结构、导航和 locale 输出都符合预期，再继续补全文案。

​
代码规范

我们以 PEP 8 为基础，并优先保持与仓库现有代码风格一致。
建议为新增或修改的公共接口补充类型注解，以提高可读性和安全性。
  • 所有公共 API 都应有清晰的文档字符串
  • 文档注释建议遵循 Google Python 文档风格
  • 更新功能时，请同步更新相关文档和示例

​
行为准则

请尊重所有项目参与者，保持友好的交流环境。任何形式的骚扰、歧视或冒犯行为都不可接受。

​
获取帮助

如果你在贡献过程中遇到问题，可以： 再次感谢你对 SimpleLLMFunc 的贡献。