Contributing to FlashOptim

March 3, 2026 ยท View on GitHub

Thanks for your interest in contributing to FlashOptim! Here's how to get started.

Development Setup

git clone https://github.com/databricks/flashoptim.git
cd flashoptim
pip install -e ".[dev]"

Code Style

We use ruff for linting and formatting, enforced via pre-commit hooks.

Install the pre-commit hooks:

pre-commit install

You can run all checks manually at any time:

pre-commit run --all-files

Running Tests

python -m pytest test/

Submitting Changes

  1. Fork the repository and create a feature branch.
  2. Make your changes and ensure pre-commit run --all-files passes.
  3. Add or update tests as appropriate.
  4. Open a pull request with a clear description of the change.