Development Documentation

This directory contains documentation for developers working on the Fukuii codebase.

Contents

Repository Structure

• Repository Structure - Detailed guide to the repository organization and codebase layout

Development Guides

• Addressing Warnings - Guide to addressing compiler and linter warnings
• Vendored Modules Integration Plan - Plan for integrating vendored dependencies

Related Documentation

• Contributing Guide - How to contribute to the project
• Testing Documentation - Testing strategies and guides
• ADRs - Architecture Decision Records

Getting Started

1. Review the Repository Structure to understand the codebase layout
2. Follow the Contributing Guide for development setup
3. Check ADRs for architectural decisions that affect your work

Development Workflow

# Clone with submodules
git clone --recursive https://github.com/chippr-robotics/fukuii.git
cd fukuii

# Build
sbt compile

# Run tests
sbt test

# Format and check code
sbt pp  # "prepare PR" - formats, checks, and tests

# Build distribution
sbt dist

See the Contributing Guide for more details.