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.

referencesdocumentation.md

≈228 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Documentation and Comments

Public API Documentation

  • Classes: explain the intended usage, with a concise example when the usage is not obvious from the signature. Document every public attribute. For Pydantic models, document fields with an attribute docstring under the field — see the Pydantic reference.
  • Methods and functions: document every argument, the return value, and each exception raised.

Internal Implementation Comments

  • Explain why, not what. The code says what it does; a comment earns its place by saying why it does it that way — the constraint, the bug, or the ordering requirement that is not visible from the code.
  • No links to RFCs, design docs, issues, or pull requests. They rot faster than the code, and a reader who cannot open the link is left with nothing. Put the reasoning in the comment itself and the link in the pull request.

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