Contributing to Kubelings

We welcome contributions of new exercises, bug fixes, performance improvements, and documentation polish!

Local Development Setup

Clone the repository:

git clone https://github.com/dnf0/kubelings.git
cd kubelings

Create a virtual environment and install dev dependencies:

uv venv
source .venv/bin/activate
uv pip install -e ".[dev]"

Install pre-commit hooks:

pre-commit install --hook-type commit-msg --hook-type pre-commit

Running Tests

Run all unit & integration tests:
```
pytest
```
Run reference solution self-tests:
```
kubelings test
```

Lint and typecheck:

ruff check .
ruff format --check .
pyright

Adding New Exercises

Create the starter exercise file under exercises/<chapter_name>/<exercise_name>.py with placeholders that fail validation initially.
Create the corresponding reference solution under solutions/<chapter_name>/<exercise_name>.py.
Register the exercise in src/kubelings/manifest.py with 2-3 progressive hints.
Add unit tests verifying both the broken starter state and working solution pass state.

Conventional Commits

We follow the Conventional Commits standard. Commit messages must start with: - feat: for new features or exercises - fix: for bug fixes - docs: for documentation updates - test: for test additions/modifications - chore: for tooling or infrastructure changes