All skills
google avatar

/adk-style

@29933ce
by googlegoogle/adk-python22k stars
4,084

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

This session only. Nothing lands on disk.

SKILL.md

≈202 tokens always: the name and description. ≈495 when used: this file. ≈7.1k more on demand in 10 files.

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 imports.md
Annotating args and returns; Optional vs | None; keyword-only args; isinstance; asserts; mypy 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 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

Source: SKILL.md on GitHub

No alerts16d3 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides comprehensive Python style and codebase conventions for the Agent Development Kit (ADK). It covers visibility, imports, typing, Pydantic models, formatting, and testing, all of which align with standard software development best practices.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

Signed by skilld at 29933ce. 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 months ago

README badge

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