This project provides AI coding assistants with accurate Jetpack Compose knowledge, addressing the common issue of AI generating incorrect or suboptimal Compose code. By integrating curated reference guides and actual androidx/androidx source code, it enables AI tools to offer grounded, reliable coding assistance for Android developers.

How It Works

The skill operates by providing AI agents with two layers of information: 13 markdown-based reference guides detailing Compose best practices, common pitfalls, and patterns, and 5 Kotlin source files directly extracted from the androidx/androidx repository. When an AI encounters a Compose-related query, it consults these resources instead of relying on potentially flawed internal knowledge, ensuring code adheres to actual implementation details and established patterns.

Quick Start & Requirements

Installation involves cloning the repository and placing the jetpack-compose-expert-skill directory into specific locations depending on the AI tool:

• Claude Code: ~/.claude/skills/ (personal) or .claude/skills/ (project-specific).
• Codex CLI / Gemini CLI: Add AGENTS.md or GEMINI.md to the project root and include the repo as a Git submodule (.compose-skill).
• Cursor: Create .cursor/rules/compose-skill.mdc or paste content into AI settings.
• GitHub Copilot: Add to .github/copilot-instructions.md.
• Windsurf: Create .windsurf/rules/compose-skill.md.
• Amazon Q Developer: Add to .amazonq/rules/compose.md.
• Other AI Tools: Clone the repository and point the tool's instruction file at jetpack-compose-expert-skill/SKILL.md. No specific software prerequisites are listed for the skill itself.

Highlighted Details

• Source Code Grounding: Leverages actual Kotlin source files from androidx/androidx (main branch) to prevent AI hallucination and ensure code correctness.
• Comprehensive Coverage: 13 reference guides cover essential Compose topics, including state management, performance, navigation, theming, and accessibility.
• AI Tool Agnostic: Designed for integration with a wide array of AI coding assistants, including Claude Code, Codex, Gemini, Copilot, Cursor, Windsurf, and Amazon Q.
• Practical Guidance: Offers do/don't examples and common pitfalls derived from real-world Compose development.

Maintenance & Community

Contributions are welcomed, particularly for expanding coverage to new Compose APIs, addressing newer releases, adding more source files, supporting Compose Multiplatform, and developing auto-update tooling. No specific community channels (like Discord/Slack) or notable contributors/sponsors are listed.

Licensing & Compatibility

The guidance documents are provided under the MIT license, while the included androidx/androidx source code is under the Apache License 2.0. Both licenses are permissive, generally allowing for commercial use and integration into closed-source projects.

Limitations & Caveats

Coverage for Compose Multiplatform (Desktop, iOS, Web) is noted as an area for potential expansion. The skill includes guidance for experimental APIs like the Styles API, acknowledging potential "alpha06 gotchas," indicating that these areas may be subject to change or instability. Its effectiveness relies on the AI tool's capability to properly interpret and utilize the provided markdown and source code.