Contributing

Contributions are welcome! This page covers how to set up a development environment and submit changes.

Development setup

Fork and clone the repository:

git clone https://github.com/<your-user>/crispyx.git
cd crispyx

Create a virtual environment and install in editable mode with test dependencies:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[test,docs]"

Verify the test suite passes:
```
pytest
```

Running tests

# Run the full suite
pytest

# Run a specific test file
pytest tests/test_workflow.py

# Run tests with verbose output
pytest -v

Building documentation

# Install doc dependencies
pip install -e ".[docs]"

# Build HTML docs
sphinx-build docs docs/_build/html

# Open in browser
open docs/_build/html/index.html    # macOS
xdg-open docs/_build/html/index.html  # Linux

Code style

Follow PEP 8 conventions.
Use NumPy-style docstrings for all public functions.
Type annotations are encouraged for function signatures.
Keep imports sorted (stdlib → third-party → local).

Submitting changes

Create a feature branch:
```
git checkout -b feature/my-improvement
```
Make your changes and add tests if applicable.
Ensure all tests pass and the documentation builds without errors.
Open a pull request against the main branch.

Reporting issues

Please use the GitHub issue tracker to report bugs or request features. Include:

A minimal reproducible example
Python version and OS
crispyx version (cx.__version__)
Full traceback for errors