imgui-java AGENTS.md

AGENTS.md

Guidance for AI coding agents working on imgui-java.

This file is the operational guide: what the repo is, how to build it, the procedure for upgrading submodules, and the codegen-internals conventions. The everyday conventions and "don't"s live in companion files — read them too:

• .claude/rules/guardrails.md — what not to do. Covers the golden rules (never edit src/generated/java/, never commit bin/ natives), the JNI contract, Java 8 compatibility on consumed classes, doclint pitfalls, dependency hygiene, AST drift, and the rule against mixing submodule bumps with feature work.
• .claude/rules/codestyle.md — Java style for imgui-binding/, imgui-lwjgl3/, imgui-app/ (formatting, naming, modifiers, imports, javadoc, wrapper class shape, binding-source annotations). Authoritative copy is config/checkstyle/checkstyle.xml.
• .claude/docs/patterns.md — recurring patterns when adding to the binding (the codegen loop, annotated stubs, struct wrappers, out-parameter Im* wrappers, module boundaries, application lifecycle).
• CONTRIBUTING.md — the human-facing contributor guide, and the authority on everything commit- and release-shaped: the conventional-commit types/scopes tables, PR title and body rules (PRs are squash-merged, so the PR title must be a valid commit header), label mapping, the versioning scheme (version tracks Dear ImGui, so it can never signal a break), the release procedure, and — importantly — the Co-authored-by trailer rule for AI-assisted commits plus the "you are responsible for the change" rule. Read it before writing a commit message or opening a PR.

If anything below conflicts with those files, the dedicated file wins — update it there, not here.

What this repo is

JNI-based Java binding for Dear ImGui + extensions (ImPlot, ImNodes, ImGuizmo, imgui-node-editor, imgui-knobs, imgui-file-dialog, imgui-text-edit, imgui-club). Multi-module Gradle build, published as io.github.spair:imgui-java-{binding,lwjgl3,app}. Java is codegen-driven: annotated stubs in imgui-binding/src/main/java/, expanded by the Spoon-based generator in buildSrc/ into imgui-binding/src/generated/java/ — both trees committed.