Contributing to dartpy

We welcome contributions to dartpy! For general contribution guidelines, please see the main contribution guide.

Python-Specific Guidelines

When contributing to dartpy, please also consider these Python-specific guidelines:

Code Style

  • Follow PEP 8 style guidelines for Python code

  • Use type hints where appropriate

  • Write clear docstrings for all public functions and classes

Testing

  • Add tests for new functionality in the python/tests directory

  • Ensure all existing tests pass before submitting a pull request

  • Run tests using: pixi run test-dartpy

Documentation

  • Update or add documentation for any new features

  • Include usage examples in docstrings

  • Update relevant tutorial or example files

For more information, see the main contribution guide.