Contributing¶

We welcome contributions to cortexlab-fusi-utils! This guide will help you get started.

Getting Started¶

1. Open an issue to discuss your idea or bug fix.
2. Fork the repository on GitHub.
3. Clone your fork locally.
4. Set up the development environment.
5. Make your changes.
6. Submit a pull request.

Development Setup¶

# Clone your fork.
git clone https://github.com/sdiebolt/cortexlab-fusi-utils.git
cd cortexlab-fusi-utils

# Install with development dependencies.
uv sync

# Run tests.
just test

# Run pre-commit hooks.
just pre-commit

Code Style¶

• Use ruff for linting and formatting.
• Use ty for type checking.
• Run pre-commits (e.g., using prek) and tests before committing.
• Add tests for new functionality.
• Update documentation as needed.
• Use NumPy docstring format for all public functions.

Reporting Issues¶

If you find a bug or have a feature request:

1. Check if the issue already exists.
2. Create a new issue with a clear description.
3. Include steps to reproduce (for bugs).
4. Include code examples if applicable.

Code of Conduct¶

Be respectful and constructive in all interactions.