Volcengine ADK贡献代码
欢迎为 VeADK 贡献代码与文档。本页带你完成本地开发环境的搭建和提交流程。
准备开发环境
克隆并安装
VeADK 需要 Python 3.10+。以可编辑模式安装，并带上开发依赖：
git clone https://github.com/volcengine/veadk-python.git
cd veadk-python
pip install -e ".[dev]"仓库使用 uv 管理依赖与锁文件，你也可以用它一步装好（含 dev 分组）：
uv sync --extra dev可选依赖按需安装：extensions（记忆 / 知识库后端）、eval（评测）、a2ui（智能体驱动 UI）等。例如 pip install -e ".[dev,eval]"。
安装 pre-commit 钩子
pre-commit 会在你提交代码前运行 Ruff（格式化与 lint）和 gitleaks（密钥泄漏检查）。未通过这些检查的提交无法通过 GitHub CI，也就无法被合并。
pre-commit installdev 依赖里已包含 pre-commit。安装后，每次 git commit 都会自动运行钩子；也可以手动对全部文件运行一次：
pre-commit run --all-files运行测试
测试位于 tests/ 目录，使用 pytest：
pytest只运行某个文件或目录：
pytest tests/test_agent.py部分测试需要火山引擎凭据或外部后端（如 Redis、OpenSearch）。这类测试在缺少对应环境变量时会跳过或失败，提交 PR 前请关注与你改动相关的用例。
开发规范
- 遵循 Google Python 风格指南。
- 提交前确保
pre-commit run --all-files与pytest通过。 - 改动涉及行为或接口时，同步更新
docs/与README.md。
提交 Pull Request
Fork 并新建分支
git checkout -b feat/your-feature提交并推送
确保 pre-commit 与测试通过后提交、推送到你的 Fork。
发起 PR
在 GitHub 上向 volcengine/veadk-python 的 main 分支发起 Pull Request，清晰描述改动动机与内容。维护者通常会在 1 至 2 个工作日内处理。