Contributing Guide
Thank you for your interest in the NeoRuntime Platform Python SDK!
Development Environment Setup
Clone the repository:
git clone https://github.com/camthink-ai/neoruntime-sdks.git
cd sdk-python
Create a virtual environment:
python3 -m venv venv
source venv/bin/activate
Install development dependencies:
pip install -e ".[dev]"
Code Standards
We use the following tools to ensure code quality:
black: Code formatting
flake8: Code linting
mypy: Type checking
Run checks:
# Format code
black neoruntime_ipc_sdk tests
# Lint code
flake8 neoruntime_ipc_sdk tests
# Type check
mypy neoruntime_ipc_sdk
Testing
Run all tests:
pytest tests/
Run specific tests:
pytest tests/test_inference.py
Generate coverage report:
pytest --cov=neoruntime_ipc_sdk --cov-report=html tests/
Submitting Code
Create a new branch:
git checkout -b feature/my-feature
Commit changes:
git add .
git commit -m "feat: add new feature"
Push the branch:
git push origin feature/my-feature
Create a Pull Request
Commit Message Convention
Use Conventional Commits format:
feat:: New featurefix:: Bug fixdocs:: Documentation updatestyle:: Code formattingrefactor:: Code refactoringtest:: Testing relatedchore:: Build/tooling related
Documentation
Build documentation:
cd docs
make html
View documentation:
open _build/html/index.html
Reporting Issues
If you find a bug or have a feature suggestion, please create an issue on GitHub:
License
This project is licensed under the MIT License.