Contributing to MatterTune

We welcome contributions to MatterTune! Whether you’re fixing bugs, adding new features, improving documentation, or reporting issues, your help is appreciated.

How to Contribute

  1. Fork the repository

  2. Create a new branch for your feature

  3. Make your changes

  4. Submit a pull request

For detailed contribution guidelines, please see our Contributing Guidelines in the repository.

Development Setup

  1. Fork and clone the repository

  2. Create a virtual environment

  3. Install development dependencies

  4. Run tests to ensure everything is working

Code Style

We follow standard Python code style guidelines:

  • Use Black for code formatting

  • Follow PEP 8 guidelines

  • Write descriptive docstrings

  • Add type hints where appropriate

Testing

Please ensure all tests pass before submitting a pull request:

pytest tests/

Documentation

When contributing new features, please:

  1. Add docstrings to new functions and classes

  2. Update relevant documentation files

  3. Add examples where appropriate