贡献指南¶
我们欢迎对 OntoMem 的贡献!以下是入门方式。
开发设置¶
# 克隆仓库
git clone https://github.com/yifanfeng97/ontomem.git
cd ontomem
# 安装开发依赖
uv sync --group dev
进行更改¶
- 创建功能分支:
git checkout -b feature/your-feature - 进行更改
- 运行测试:
pytest tests/ - 格式化代码:
black . - 提交:
git commit -m "Add feature description" - 推送:
git push origin feature/your-feature - 创建拉取请求
代码风格¶
- 使用
black进行格式化 - 使用
ruff进行代码检查 - 遵循 PEP 8
- 为函数添加文档字符串
测试¶
# 运行所有测试
pytest tests/
# 运行特定测试文件
pytest tests/test_core.py
# 运行覆盖率测试
pytest --cov=ontomem tests/
文档¶
- 为新功能更新文档字符串
- 如果添加新功能,更新 README
- 构建文档:
mkdocs serve
Issues 和讨论¶
- Bug 报告:GitHub Issues
- 功能请求:GitHub Issues
- 问题:GitHub Discussions
感谢你的贡献!🚀