Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (27 loc) · 703 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 703 Bytes

Contributing to HyperFlow

First off, thanks for taking the time to contribute!

How to Contribute

  1. Reporting Bugs: Use GitHub Issues.
  2. Feature Requests: Check existing issues before opening a new one.
  3. Pull Requests:
    • Fork the repo.
    • Create a new branch.
    • Ensure code passes lints (if applicable).
    • Submit the PR!

Environment Setup

# Clone the repository
git clone https://github.com/lablnet/HyperFlow.git
cd HyperFlow

# Create a virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install dependencies
pip install -e ".[dev]"

Linting

We use ruff for linting and formatting:

ruff check .
ruff format .