// Run `mvn spotless:apply` to fix Java checkstyle / formatting failures and verify the result. Run after authoring or modifying any `.java` files, or when CI reports a "Java checkstyle failed" / "Fix Java checkstyle" issue on a PR.
| name | java-checkstyle |
| description | Run `mvn spotless:apply` to fix Java checkstyle / formatting failures and verify the result. Run after authoring or modifying any `.java` files, or when CI reports a "Java checkstyle failed" / "Fix Java checkstyle" issue on a PR. |
OpenMetadata enforces Java formatting via the Spotless Maven plugin. Every CI
build runs mvn spotless:check and fails the PR if any file is not formatted.
Java checkstyle failed / Fix Java checkstyle comment on a PR
(the bot's exact phrasing is "Please run mvn spotless:apply in the root of
your repository and commit the changes to this PR")..java files — before
opening a PR or pushing a commit that touches Java.From the repo root run Spotless:
mvn spotless:apply # formats everything
# or
mvn -pl <module> spotless:apply # scope to a single Maven module for speed
# or
mvn spotless:check # verify only, without rewriting files
Spotless is fast (seconds, no compilation). If it fails with a plugin error rather than a formatting diff, surface the error and stop — do not try to hand-edit formatting around the failure.
Inspect the diff:
git status --short
git diff --stat
Expect changes only in .java (and possibly pom.xml) files. If Spotless
keeps rewriting a change you just made, re-read the root pom.xml's
spotless-maven-plugin config — Spotless is the source of truth, not the
IDE.
Only commit if the user asked to. Report the changed-file list first so the user can decide whether to fold the reformat into the in-progress commit or make a separate "Fix Java checkstyle" commit (matches the repo's existing history for bot-triggered formatting-only commits).
yarn pretty / ESLint flow (see AGENTS.md
UI section).make py_format (black + isort + pycln).Build a new OpenMetadata connector from scratch — scaffold JSON Schema, Python boilerplate, and AI context using schema-first architecture with code generation across Python, Java, TypeScript, and auto-rendered UI forms.
Run the ESLint + Prettier + organize-imports sequence that CI's `UI Checkstyle` jobs (`lint-src`, `lint-playwright`, `lint-core-components`) run — on just the files the PR changed — and fail if any file ends up with a diff. Run after authoring or modifying any `.ts`/`.tsx`/`.js`/`.jsx`/`.json` under `openmetadata-ui/src/main/resources/ui/src/`, `.../playwright/`, or `openmetadata-ui-core-components/src/main/resources/ui/src/`, or when CI reports a `UI Checkstyle` failure on a PR.
Run `mvn spotless:apply` to fix Java checkstyle / formatting failures and verify the result. Invoke after authoring or modifying any `.java` files, or when CI reports a "Java checkstyle failed" or "Fix Java checkstyle" issue on a PR.
Run the exact ESLint + Prettier + organize-imports sequence that CI's `UI Checkstyle` jobs (`lint-src`, `lint-playwright`, `lint-core-components`) run — on just the files the PR changed — and fail the task if any file ends up with a diff. Invoke after authoring or modifying any `.ts`, `.tsx`, `.js`, `.jsx`, or `.json` file under `openmetadata-ui/src/main/resources/ui/src/`, `.../playwright/`, or `openmetadata-ui-core-components/src/main/resources/ui/src/`, or when CI reports a "UI Checkstyle" job failure on the PR.
Meta-skill loaded at session start. Directs Claude to check for applicable OpenMetadata skills before starting any task. Ensures structured workflows are followed.
Use when opening or finalizing a GitHub PR for OpenMetadata. Walks through the repo PR template — linked issue, high-level design (for big PRs), unit/integration/Playwright tests + coverage, UI screen recording, and manual test steps — then drafts a fully-filled PR body and (optionally) creates the PR.
