Skip to content

Contributor Guide

ravikiranpagidi edited this page Jun 17, 2026 · 1 revision

Contributor Guide

Thank you for improving Great Generator.

Local setup

git clone https://github.com/ravikiranpagidi/great-generator.git
cd great-generator
python -m venv .venv
.venv\Scripts\activate
pip install -e ".[dev]"

Before opening a pull request

ruff check .
black --check .
pytest
python -m build
python -m twine check dist/*

Good contribution areas

  • realistic reference values
  • new domain packs
  • Spark generation improvements
  • examples and notebooks
  • docs and tutorials
  • anomaly types
  • benchmark scripts
  • export improvements

Design principles

  • relational integrity by default
  • anomalies only when explicitly requested
  • deterministic seeds for tests and research
  • optional Spark/Delta dependencies
  • simple public APIs
  • documentation that helps users succeed quickly

Clone this wiki locally