贡献指南
感谢你对 NeoRuntime Platform Python SDK 的关注!
开发环境设置
克隆仓库:
git clone https://github.com/camthink-ai/neoruntime-sdks.git
cd sdk-python
创建虚拟环境:
python3 -m venv venv
source venv/bin/activate
安装开发依赖:
pip install -e ".[dev]"
代码规范
我们使用以下工具确保代码质量:
black: 代码格式化
flake8: 代码检查
mypy: 类型检查
运行检查:
# 格式化代码
black neoruntime_ipc_sdk tests
# 代码检查
flake8 neoruntime_ipc_sdk tests
# 类型检查
mypy neoruntime_ipc_sdk
测试
运行所有测试:
pytest tests/
运行特定测试:
pytest tests/test_inference.py
生成覆盖率报告:
pytest --cov=neoruntime_ipc_sdk --cov-report=html tests/
提交代码
创建新分支:
git checkout -b feature/my-feature
提交更改:
git add .
git commit -m "feat: add new feature"
推送分支:
git push origin feature/my-feature
创建 Pull Request
提交信息规范
使用 Conventional Commits 规范:
feat:: 新功能fix:: 修复 bugdocs:: 文档更新style:: 代码格式调整refactor:: 代码重构test:: 测试相关chore:: 构建/工具相关
文档
构建文档:
cd docs
make html
查看文档:
open _build/html/index.html
问题反馈
如果你发现 bug 或有功能建议,请在 GitHub 上创建 issue:
许可证
本项目采用 MIT 许可证。