Skip to content

Code Review Standards

James Maes edited this page Sep 24, 2026 · 6 revisions

Code review standards

QQQ 4.0 release. Final 4.0.0 is available. See QQQ 4.0 for release scope and migration guidance.

Follow the selected repository's CODE_STYLE.md, Checkstyle configuration, scoped contributor instructions, and POM gates. Current branch protection and code-owner requirements are authoritative; a historical wiki claim that any one approval is sufficient does not override them.

Author and reviewer checklist

  • Explain the concrete behavior change, affected entry points, and any migration impact.
  • Verify the relevant tests, complete required build/style/coverage gates, and inspect the resulting reports.
  • Use the actual metadata producer, record entity, backend SPI, and process-step contracts. Compile examples against the selected source.
  • Preserve component license headers and references; do not infer a blanket grant from the repository name or a marketing page.
  • Check application permissions, validation, context cleanup, failure handling, and transaction boundaries where the change affects them.
  • Preserve unrelated changes and review the final diff before creating a signed conventional commit.

Java source uses the repository's established formatting and naming. QRecord is not a Java interface, and metadata classes are not annotations. Use QRecordEntity and real field annotations for typed entities. Reference Public API Overview and Testing instead of the obsolete illustrative signatures previously on this page.

Clone this wiki locally