You are viewing a snapshot of the in-development Lucille documentation.

This pre-release version reflects the current state of main and may contain unreleased changes.
For the stable release, see the latest version.

Contributor Guide

For contributors to the Lucille codebase — project structure, setup, and coding standards.

This section is for developers contributing code back to the Lucille project. It covers how the project is structured, how to set up your development environment, and the coding conventions used throughout the codebase.

If you are writing components for your own project rather than contributing to Lucille itself, see the Component Developer Guide instead.


Project Structure and Build

The multi-module Maven project structure, how the build works, and how to use custom components with Lucille.

Setup & Standards

Coding standards for Lucille and how to set up for local development.

Coding Conventions

Formatting, naming, class structure, Javadoc, and test conventions used in the Lucille codebase.