Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (62 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

87 lines (62 loc) · 1.94 KB

Contributing to StreamFlow Analytics

Thank you for your interest in contributing to StreamFlow Analytics!

Development Setup

  1. Clone the repository:

    git clone https://github.com/arthurmgraf/streamflow-analytics.git
cd streamflow-analytics

  2. Create a virtual environment:

    python -m venv .venv
source .venv/bin/activate

  3. Install dependencies:

    pip install -e ".[dev]"

  4. Start infrastructure (requires K3s):

    # Bootstrap K3s and deploy operators
bash scripts/setup.sh

# Deploy StreamFlow services
make deploy

Code Standards

  • Linting: ruff check src/ tests/
  • Type checking: mypy src/ --strict
  • Formatting: ruff format src/ tests/
  • Testing: pytest tests/ -v

All code must pass linting, type checking, and tests before merge.

Testing

# Unit tests
pytest tests/unit/ -v

# Contract tests
pytest tests/contract/ -v

# Integration tests
pytest tests/integration/ -v -m integration

# Full test suite with coverage
pytest tests/ --cov=src --cov-report=term-missing

Minimum coverage threshold: 80%

Pull Request Process

  1. Fork the repository and create a branch from main
  2. Make your changes with tests
  3. Ensure CI passes (lint + type check + tests)
  4. Write a clear PR description explaining the "why"
  5. Request a review

Commit Convention

We use Conventional Commits:

  • feat: � New feature
  • fix: � Bug fix
  • docs: � Documentation only
  • refactor: � Code refactoring
  • test: � Adding or updating tests
  • chore: � Maintenance tasks
  • infra: � Infrastructure changes

Architecture Decision Records

For significant architectural changes, create an ADR in docs/adr/. Use the template format:

  • Title, Status, Context, Decision, Consequences

License

By contributing, you agree that your contributions will be licensed under the MIT License.