Contributing ============ We welcome contributions to DiRe-JAX! Here's how you can help: Getting Started --------------- 1. **Fork the repository** on GitHub 2. **Clone your fork** to your local machine 3. **Create a new branch** for your feature or bugfix 4. **Make your changes** 5. **Run tests** to ensure everything works correctly 6. **Commit your changes** with descriptive commit messages 7. **Push to your fork** on GitHub 8. **Create a pull request** to the main repository Development Setup ----------------- .. code-block:: bash git clone https://github.com/your-username/dire-jax.git cd dire-jax pip install -e .[utils] Running Tests ------------- .. code-block:: bash cd tests python run_tests.py Coding Guidelines ----------------- * Follow PEP 8 style guidelines * Write docstrings in NumPy/SciPy format * Add tests for new features * Update documentation as needed Submitting Pull Requests ------------------------ When submitting a pull request, please: 1. Reference any related issues 2. Include a clear description of the changes 3. Update documentation, if applicable Thank you for contributing to DiRe-JAX!