Skip to main content

Contributing

Prepare the repository​

Install Java 25 and the native OCR prerequisites described in Prerequisites. Use the Maven wrapper rather than assuming a globally installed Maven version.

Make a focused change​

Keep service changes, fixture changes, and documentation changes explicit. Changes to image geometry, thresholds, OCR setup, answer-key parsing, or response fields should include an appropriate test or a clear explanation of why existing tests cannot cover the behavior.

Documentation claims should link to source, tests, fixtures, or configuration that establishes them. Do not turn fixture results into production accuracy claims.

Verify before review​

./mvnw test

If a change affects the documentation site, also run the documentation validator and build from the repository root as described in the docs workflow.