Contributing¶

Thanks for helping improve TerraFlow! Here are the basics for v0.2.0+.

Contribution Workflow¶

flowchart LR
    A[Fork Repository] --> B[Clone & Setup]
    B --> C[Create Branch]
    C --> D[Make Changes]
    D --> E[Run Tests]
    E --> F{Tests Pass?}
    F -->|No| D
    F -->|Yes| G[Run Linting]
    G --> H{Lint Pass?}
    H -->|No| D
    H -->|Yes| I[Commit Changes]
    I --> J[Push to Fork]
    J --> K[Create PR]
    K --> L[Code Review]
    L --> M[Merge]

    style E fill:#00b0ff,stroke:#0091ea,color:#fff
    style G fill:#00b0ff,stroke:#0091ea,color:#fff
    style M fill:#2d8a55,stroke:#1e5c3a,color:#fff

Local setup¶

make dev

This creates a virtual environment and installs development dependencies.

Run tests¶

make test

Linting¶

make lint

Documentation¶

Install docs dependencies and run a local preview:

uv pip install -r docs/requirements.txt
mkdocs serve

mkdocs build --strict