Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (52 loc) · 966 Bytes

CONTRIBUTING.md

File metadata and controls

76 lines (52 loc) · 966 Bytes

Contributing

Thanks for helping improve Weaver!

Prerequisites

  • Python 3.11+
  • Node.js 18+ (Node 20+ recommended)
  • pnpm (for web/)

Backend Setup

make setup

Optional heavy tool dependencies (desktop automation / Office docs / crawler extras):

make setup-full

Frontend Setup

cd web
pnpm install

Common Commands

# Lint (ruff)
make lint

# Format (ruff format)
make format

# Tests (pytest)
make test

# Everything (lint + tests + secret scan)
make check

pre-commit

Install hooks:

.venv/bin/pre-commit install

Run on all files:

.venv/bin/pre-commit run -a

Secret Handling

  • Never commit real API keys.
  • Use .env.example as a template and keep .env local.
  • Local scan:
.venv/bin/python scripts/secret_scan.py

CI Expectations

Pull requests should pass:

  • Backend lint + tests
  • Secret scan
  • Frontend lint + build
  • Docker image build