tomevault-io OpenMetadata Development Workflow
This skill is loaded automatically at session start. It ensures you follow the right workflow for every task.
Before Starting Any Task
Check which skills apply to your task and use them. This is not optional — if a skill applies, you must follow it.
Skill Selection Guide
| Task type | Required skill(s) |
|---|---|
| New feature (multi-file) | /planning then /tdd then /test-enforcement then /verification |
| Bug fix | /systematic-debugging then /tdd (write regression test) then /verification |
| New API endpoint | /planning then /tdd then /test-enforcement (must include integration test) |
| New connector | /connector-standards then /connector-building then /test-enforcement |
| UI component | /tdd then /test-enforcement (must include Jest + Playwright if user-facing) |
| Code review / PR review | /code-review then /test-enforcement |
| Opening / finalizing a PR | /test-enforcement then /verification then /pr-checklist |
| Connector review | /connector-review |
| E2E test creation | /playwright |
| Finishing implementation | /test-enforcement then /verification |
Note: Connector skills (
/connector-standards,/connector-building,/connector-review) and/playwrightare part of the OpenMetadata Skills plugin and ship together with this workflow skill. They are defined in theskills/directory alongside this file.
Workflow Rules
Plan before coding. For any non-trivial task, use
/planningto design the approach before writing code.Test-first when possible. Use
/tddto write failing tests before implementation. This applies to Java, Python, and TypeScript equally.Always enforce test coverage. Before any PR, use
/test-enforcementto verify:- 90% line coverage on changed Java classes
- Integration tests for all changed/new API endpoints
- Playwright E2E tests for new user-facing features
- Jest unit tests for new React components
Verify with evidence. Use
/verificationbefore claiming completion. Show actual test output, not claims.Review before merging. Use
/code-reviewfor two-stage review (spec compliance + code quality).Fill the PR template completely. Use
/pr-checklistbeforegh pr createto gather every required section: linked issue, high-level design (large PRs), tests + coverage, UI screen recording, and manual test steps.
OpenMetadata Cross-Layer Checklist
When your task touches multiple layers, ensure all are synchronized:
- JSON Schema in
openmetadata-spec/→ runmake generate - Connection schema → run
yarn parse-schema - Java entity changes → Flyway migration in
bootstrap/sql/migrations/ - Backend API changes → update frontend API client
- New UI strings → add to
locale/languages/en-us.jsonthen runyarn i18n - Java files → run
mvn spotless:apply - Python files → run
make py_format && make py_format_check - TypeScript/React files → run
yarn organize-imports:cli && yarn lint:fix && yarn pretty:base --write - New source files → ensure Apache 2.0 license header (run
yarn license-header-fix) - Application changes → run
yarn generate:app-docs
CLAUDE.md Takes Precedence
If CLAUDE.md instructions conflict with any skill, CLAUDE.md wins. Skills are supplementary workflows, not overrides.
Source: open-metadata/OpenMetadata — distributed by TomeVault.