Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.01 KB

Contributing to RuleChef

Development Setup

git clone https://github.com/KRLabsOrg/rulechef.git
cd rulechef
pip install -e ".[dev,grex]"

Running Tests

# All tests (excluding live API tests)
pytest --ignore=tests/test_incremental_live.py -q

# With coverage
pytest --ignore=tests/test_incremental_live.py --cov=rulechef

# Live API tests (requires OPENAI_API_KEY)
pytest tests/test_incremental_live.py -m integration

Code Style

We use ruff for linting and formatting, and mypy for type checking.

# Lint
ruff check .

# Auto-fix lint issues
ruff check . --fix

# Type check
mypy rulechef/ --ignore-missing-imports

CI runs these checks on every pull request. Make sure they pass before submitting.

Pull Requests

  1. Fork the repo and create a branch from main
  2. Make your changes
  3. Add or update tests as needed
  4. Ensure ruff check ., mypy rulechef/, and pytest all pass
  5. Open a pull request against main