Contributing¶
Development Setup¶
# Clone repository
git clone https://github.com/geneontology/noctua-py
cd noctua-py
# Install with uv
uv sync
# Run tests
just test
Code Style¶
- Use
ruff
for linting and formatting - Type hints for all public functions
- Docstrings for all classes and methods
Testing¶
Run all tests:
Individual test types:
Pull Requests¶
- Fork the repository
- Create a feature branch
- Make changes with tests
- Run
just test
to verify - Submit pull request
Documentation¶
Build docs locally:
View at http://localhost:8000