Skip to content

Contributing

Kevin Herron edited this page Oct 12, 2026 · 7 revisions

Applies to Milo 1.2.0-RC1. Source baseline 69cb25087, 2026-10-12.

This Wiki documents how to use Milo. Instructions for building and changing Milo, along with its architecture documentation, live in the source repository, and the links below lead there.

Contributor instructions

Architecture

These links use the guide's 1.2 source baseline. When you contribute, follow the instructions in the branch you are changing.

Documentation contributions

To contribute a runnable example, follow the contribution process above and submit the example and its behavioral checks together in a source pull request. The checks should assert the output and that the example closes the client or server it creates. State the Milo and Java versions it targets.

Java code blocks with a <!-- snippet: ... --> marker above them come from the Wiki examples module, where the Milo build compiles them, so an API change that breaks a sample fails the build. To change one, edit the Java source in the module, then copy it into the Wiki with the module's sync tool as its README describes.

Maintainers editing the Wiki should link each example at an exact source revision, update navigation and related pages, and preserve existing page URLs and heading anchors.

Architecture explanations, design decisions, build procedures, and contributor testing guidance belong with the source. The Wiki should explain what an application developer needs to use the API.

Clone this wiki locally