Welcome! We're excited you want to help. Here's how to get started.
Found a bug or want a feature? Open an issue.
Before submitting a PR:
- Fork the repository and create a feature branch.
- Make your changes following PEP 8 (4-space indentation).
- Add tests for new functionality in the
tests/directory. - Run the linter:
ruff check src/ tests/ - Run the tests:
pytest tests/ -v - If your change affects GPU-specific code, test on both NVIDIA and AMD GPUs when possible.
- Submit your PR with a clear description.
- Python 3.10+ compatible.
- Type hints where meaningful.
- Keep functions focused — one thing well.
- GPU auto-detection logic goes in
src/rocm_ocr/gpu.py.
Feel free to ask questions in issues or discussions.
欢迎贡献！以下是参与流程：
发现问题或想要新功能？请提交 Issue。
提交 PR 前请确认：
- Fork 仓库并创建 feature 分支。
- 遵循 PEP 8 代码规范（4 空格缩进）。
- 在
tests/目录中添加测试。 - 运行代码检查：
ruff check src/ tests/ - 运行测试：
pytest tests/ -v - 如果涉及 GPU 代码变更，尽可能在 NVIDIA 和 AMD 两种环境下测试。
- 提交 PR 并附上清晰的描述。
- 兼容 Python 3.10+。
- 有意义的类型标注。
- 保持函数专注。
- GPU 检测逻辑放在
src/rocm_ocr/gpu.py。
欢迎通过 Issues 或 Discussions 提问交流！