superset AGENTS.md

LLM Context Guide for Apache Superset

Apache Superset is a data visualization platform with Flask/Python backend and React/TypeScript frontend.

Run Pre-commit Before Pushing

Always run pre-commit against the files changed by the current branch before pushing. This matches CI and keeps unrelated failures already present on master from blocking otherwise independent work.

# Stage your changes first
git add .

# Run pre-commit on staged files
pre-commit run

# If there are auto-fixes, stage them and commit
git add .
git commit --amend  # or new commit

Use pre-commit run --all-files when auditing or repairing the repository-wide baseline. If that check finds failures in files untouched by the current branch, fix them in a separate branch rather than adding unrelated changes to the current pull request.

Common pre-commit failures:

• Formatting - black, oxfmt, eslint will auto-fix
• Type errors - mypy failures need manual fixes
• Linting - ruff, pylint issues need manual fixes

⚠️ CRITICAL: Ongoing Refactors (What NOT to Do)

These migrations are actively happening - avoid deprecated patterns:

Frontend Modernization

• NO any types - Use proper TypeScript types
• NO JavaScript files - Convert to TypeScript (.ts/.tsx)
• Use @superset-ui/core - Don't import Ant Design directly, prefer Ant Design component wrappers from @superset-ui/core/components
• Use antd theming tokens - Prefer antd tokens over legacy theming tokens
• Avoid custom css and styles - Follow antd best practices and avoid styling and custom CSS whenever possible

Testing Strategy Migration

• Prefer unit tests over integration tests
• Prefer integration tests over end-to-end tests
• Use Playwright for E2E tests - Migrating from Cypress
• Cypress is deprecated - Will be removed once migration is completed
• Use Jest + React Testing Library for component testing
• Use test() instead of describe() - Follow avoid nesting when testing principles