Developer Docs
Welcome to the Apache Superset Developer Docs - your comprehensive resource for contributing to and extending Apache Superset.
Quick Startโ
New Contributorsโ
Extension Developmentโ
Documentation Sectionsโ
Extensionsโ
Learn how to build powerful extensions that enhance Superset's capabilities. This section covers the extension architecture, development patterns, and deployment strategies. You'll find comprehensive guides on creating frontend contributions, managing extension lifecycles, and understanding security implications.
Testingโ
Comprehensive testing strategies for Superset development. This section covers frontend testing with Jest and React Testing Library, backend testing with pytest, end-to-end testing with Playwright, and CI/CD pipeline best practices.
Contributing to Supersetโ
Everything you need to contribute to the Apache Superset project. This section includes community guidelines, development environment setup, pull request processes, code review workflows, issue reporting guidelines, and Apache release procedures. You'll also find style guidelines for both frontend and backend development.
Development Resourcesโ
Prerequisitesโ
- Python: 3.9, 3.10, or 3.11
- Node.js: 18.x or 20.x
- npm: 9.x or 10.x
- Git: Basic understanding
- React/TypeScript: For frontend development
- Flask/SQLAlchemy: For backend development
Key Technologiesโ
- Frontend: React, TypeScript, Ant Design, Redux
- Backend: Flask, SQLAlchemy, Celery, Redis
- Build Tools: Webpack, Babel, npm/yarn
- Testing: Jest, Pytest, Playwright
- CI/CD: GitHub Actions, pre-commit
Communityโ
Get Helpโ
- Slack - Join #development, #troubleshooting, or #beginners
- GitHub Discussions - Ask questions and share ideas
- Mailing Lists - Development discussions
Contributeโ
- Good First Issues - Start here!
- Help Wanted - Issues needing help
- Roadmap - See what's planned
Additional Resourcesโ
External Documentationโ
- User Documentation - Using Superset
- API Documentation - REST API reference
- Configuration Guide - Setup and configuration
Important Filesโ
- CLAUDE.md - LLM development guide
- UPDATING.md - Breaking changes log
Where to Start?โ
I want to contribute code | I want to build an extension |
I found a bug | I need help |
Welcome to the Apache Superset community! We're excited to have you contribute.