Contributing

Thanks for you interest in contributing to this project.

Main tools used in this repository:

Tool	Description
astral/uv	Python project and package manager
go-task/task	Task Runner
j178/prek	pre-commit hook runner
astral/ruff	Formatting/Linting/LSP
astral/ty	Type Checking

AI Policy

Do NOT use AI to create, generate or draft any direct communication such as Issues, Comments, PR Bodies, etc.

You MUST fully understand and be able to explain what your changes do and how they interact with the codebase.

Clone the repository:

git clone https://github.com/rtuszik/photon-docker
cd photon-docker

The Brewfile can be used in order to install Task and uv with Homebrew on MacOS and Linux

brew bundle

On Windows or for other install methods, refer to the official documentation:

# installs python project with uv with dev dependencies and hooks
task install

Create a feature branch from dev.
Make your changes.
Test your changes by building and running the Docker image:
```
task rebuild
```
Verify that Photon starts successfully and OpenSearch is up.
Run checks:
```
task check
task test
```
Commit and push to your fork.
Open a pull request to the upstream dev branch.

To list available tasks:

task