For other topics not covered here (Web UI build, release process, IDE setup rationale),
see .github/DEVELOPMENT.md.
Build, test and pre-PR check commands are in the Building
section of DEVELOPMENT.md.
Before writing Java code, read the Code Style section of
DEVELOPMENT.md. Before adding or changing configuration or session properties, read its
Configuration and session properties
section.
Run mvnd airstyle:format after Java edits — the airstyle-maven-plugin (io.airlift:airstyle-maven-plugin)
applies the canonical Airstyle scheme, which is what CI checks. Scope a single file with
mvnd -pl <module> airstyle:format -Dincludes=**/FileName.java, and use airstyle:check to verify
without rewriting.
Pull request descriptions use .github/pull_request_template.md.
CI enforces these rules, so check them before pushing:
- Commit messages: the check-commit-messages policy,
run by the
check-commit-messagesjob in.github/workflows/ci.yml. - Commit structure: the
check-commits-dispatcherandcheck-commitjobs in the same file. - Pull request description:
.github/workflows/pr-description-check.yml.