Quick Start

Welcome to the Kroki-rs developer community! This guide will get you from zero to your first contribution in minutes.

1. Prerequisites¶

• Rust: Install rustup (Stable channel).

• Podman: Install Podman (Recommended for containerized verification).

• GitHub CLI: Install gh (For PR management).

2. Setup¶

# Initialize tools and base images
./dflow setup

3. Rapid Iteration¶

# Run local verification on your host OS
./dflow develop

4. First Contribution Flow¶

1. Branch: git checkout -b feat/my-cool-feature

2. Hack: Implement your changes in src/.

3. Verify: Run ./dflow ci-verify to ensure container parity.

4. Propose: ./src-scripts/gh-tasks/propose-release.sh

For detailed guidance, see:

• Architecture Overview

• Local Development Guide

• Verification Protocols