development.md

Development Guide

This guide describes the local workflow for contributors.

Setup

uv sync
pre-commit install

Daily Workflow

1. Create a branch.
2. Make code changes.
3. Run validation locally.
4. Open a pull request.

Local Validation Commands

pre-commit run --all-files
uv run poe test

For a full build pass:

uv run poe build

Code Areas

• kiwi/: image descriptions and in-image configuration script
• scripts/: build wrappers
• molecule/: scenario lifecycle and verification playbooks
• docs/: operator and contributor documentation

Quality Expectations

• keep shell scripts strict with set -euo pipefail
• keep docs aligned with executable commands
• avoid committing generated artifacts under output/