adk-style

Standardize ADK Python code formatting, typing, imports, logging, and Pydantic v2 models.

21.1k|3.8k|Updated Apr 1, 2025
One-click install
npx skills add https://github.com/google/adk-python --skill adk-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adk-style
Source: https://github.com/google/adk-python/tree/main/.agents/skills/adk-style
Command: npx skills add https://github.com/google/adk-python --skill adk-style

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill removes ambiguity during ADK development by standardizing Python idioms, formatting, typing practices, Pydantic v2 patterns, logging, and file organization so contributions stay consistent and maintainable.

Core Features & Use Cases

  • Imports & dependency boundaries: Clarifies relative vs absolute imports, TYPE_CHECKING patterns, and the strict no-dependency direction from cli/ to the rest of the codebase.
  • Typing & Pydantic v2 conventions: Establishes strong typing guidance and the preferred Pydantic v2 model patterns (e.g., Field(), PrivateAttr(), validators).
  • Formatting, documentation, and testing rules: Defines consistent code formatting, docstring expectations, logging style, and test practices that verify behavior through public interfaces.

Quick Start

Use the adk-style skill whenever you are writing or reviewing ADK Python code to align with the project's established style, tests, and documentation conventions.

Frequently Asked Questions about adk-style

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce Python code style conventions for ADK development?

To enforce Python code style for ADK, standardize formatting, typing, imports, logging, and Pydantic v2 modeling. This ensures consistent structure like license headers, future annotations, and directory organization across contributions.

What are the Pydantic v2 conventions for ADK Python code?

Pydantic v2 conventions for ADK Python code establish preferred patterns using Field(), PrivateAttr(), and validators. This provides strong typing guidance and consistent model structure for maintainable contributions.

How should I structure imports and dependencies in an ADK repository?

Structure ADK imports by clarifying relative versus absolute imports and TYPE_CHECKING patterns. Enforce a strict no-dependency direction from the cli/ directory to the rest of the codebase to maintain clear boundaries.

What testing practices should I follow for ADK Python projects?

ADK Python testing practices require verifying behavior through public interfaces. This approach standardizes test authoring to ensure contributions remain consistent, maintainable, and aligned with project documentation rules.

Do I need specific logging style and documentation for ADK code reviews?

Yes, ADK code reviews require specific logging style and docstring expectations. Standardizing these elements during routine development and PR review removes ambiguity and keeps the codebase consistent.