Skip to content

Contributing

Contributions should be narrow, source-backed, and verified at the smallest meaningful scope. Update public documentation with public API, integration, module, release, or security behavior changes.

Local checks

tools/agent/quality-gate.sh --mode fast --scope changed --block false

Use that fast non-blocking command during development. Before updating a pull request, run the strict changed-scope gate:

tools/agent/quality-gate.sh --mode strict --scope changed --block false

Public API changes also require apiCheck; publishing metadata changes require the Maven Local preflight described in the repository policy.

Documentation contract

Every user-facing fenced block is inventoried. Source-, sample-, and configuration-owned examples point to canonical source regions and are synchronized by docsUpdate; Markdown commands and illustrative Mermaid blocks declare their verification model explicitly.

Build the full public documentation locally with:

./gradlew docsSiteCheck --stacktrace

Read the complete contribution guide