Index of every page on this site: llms.txt
All skills
google avatar

/adk-style

@37de74d
by googlegoogle/adk-python22k stars
4,392
Run it yourself

Python style and codebase conventions for ADK (Agent Development Kit): private-by-default file visibility, imports, type hints, Pydantic v2 models, formatting, docstrings, logging, async I/O, file and test layout, and unit test structure. Use when writing or editing ADK source or tests, deciding whether a new file or symbol should be public or private, naming or placing a test file, fixing a formatter, linter, or type-check failure (pyink, isort, ruff, mypy, addlicense, compliance-checks), or asking whether code matches house style. Don't use for reviewing a whole changeset (use adk-review), writing a developer guide or design doc for a code unit (use adk-unit-guide or adk-unit-design), building or configuring agents (use adk-agent-builder), or installing the toolchain (use adk-setup).

Use this Skill: https://skilld.dev/gh/google/adk-python/adk-style

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈202 tokens for metadata: the name and description. ≈564 when used: this file. ≈9.3k more on demand in 10 files.

Description uses 10.1% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈808 characters, or 10.1%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

ADK Style Guide

Conventions for src/google/adk/ and tests/unittests/. Most are enforced by a pre-commit hook or a CI job, so a violation blocks the PR rather than surfacing in review. Read the one reference for the topic you are touching.

Pick a reference

Task Reference
Adding a .py file; deciding public vs private; __init__.py and __all__ visibility.md
Writing import lines; relative vs absolute; circular imports; TYPE_CHECKING; lazy imports imports.md
Annotating args and returns; AgentMode vs raw mode strings; _NodePathBuilder, _BranchPath, and build_node; X | None and X | Y instead of Optional and Union; keyword-only args; isinstance; asserts; mypy; # type: ignore and cast typing.md
Defining a Pydantic model, validator, private attribute, or on-wire payload pydantic.md
Indentation, line length, quotes; running the formatter; what each hook checks formatting.md
Writing a docstring or an explanatory comment documentation.md
Emitting a log record; naming the module logger; picking a level logging.md
Anything that performs I/O — network, disk, database async.md
Where a new file goes; license header; where its test goes and what to call it file-organization.md
Writing or restructuring a unit test; the testing_utils fakes testing.md

A check failed — where to look

Failing check Reference
check-new-py-prefix visibility.md
compliance-checks logging.md (logger name), typing.md (from __future__ import annotations), imports.md (cli/ import direction)
pyink, isort, ruff, addlicense, codespell formatting.md
Mypy Check CI job typing.md
tests/unittests/test_import_loading.py imports.md

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts15d3 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides a collection of Python style and codebase conventions for the Agent Development Kit (ADK). It outlines best practices for file organization, imports, type hints, and testing, with no security risks identified.

  • Socket15d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

Signed by skilld at 37de74d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 weeks ago

README badge

README badge for google/adk-python/adk-style