mcpField
A
adk-style

adk-style

github.com/google开发22.0k107 次安装今天更新
代码仓库

关于 adk-style

面向 `src/google/adk/` 和 `tests/unittests/` 贡献者的风格指南,将常见开发任务和检查失败对应到具体规范。

主要功能

  1. 01按主题查阅 ADK 规范
  2. 02导入与可见性指导
  3. 03类型标注和 Pydantic 指导
  4. 04格式、文档与日志规则
  5. 05测试和文件组织指导

适用场景

  1. 01修改 ADK 代码前核对规范
  2. 02为失败的 pre-commit 或 CI 检查查找依据

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/google/adk-python --skill adk-style

安装后在 Claude Code 中输入/adk-style确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
async.md
documentation.md
file-organization.md
formatting.md
imports.md
logging.md
pydantic.md
testing.md
typing.md
visibility.md

详细介绍

ADK 风格指南

适用于 src/google/adk/ 和 tests/unittests/ 的约定。大多数规则由 pre-commit 钩子或 CI 任务强制执行,因此违反规则会阻止 PR,而不是等到 代码审查时才发现。请阅读与你正在处理的主题对应的参考文档。

选择参考文档

任务参考文档
添加 .py 文件;确定公开还是私有;__init__.py 和 __all__visibility.md
编写 import 语句;相对导入与绝对导入;循环导入;TYPE_CHECKING;延迟导入imports.md
标注参数和返回值;AgentMode 与原始模式字符串;_NodePathBuilder、_BranchPath 和 build_node;Optional 与 | None;仅限关键字参数;isinstance;断言;mypy;# type: ignore 和 casttyping.md
定义 Pydantic 模型、验证器、私有属性或线上载荷pydantic.md
缩进、行长、引号;运行格式化工具;各钩子的检查内容formatting.md
编写文档字符串或说明性注释documentation.md
输出日志记录;命名模块日志记录器;选择日志级别logging.md
任何执行 I/O 的操作——网络、磁盘、数据库async.md
新文件的存放位置;许可证标头;测试的存放位置及命名方式file-organization.md
编写或重构单元测试;testing_utils 中的模拟对象testing.md

检查失败——应查阅哪里

失败的检查参考文档
check-new-py-prefixvisibility.md
compliance-checkslogging.md(日志记录器名称)、typing.md(from __future__ import annotations)、imports.md(cli/ 导入方向)
pyink、isort、ruff、addlicense、codespellformatting.md
Mypy Check CI 任务typing.md
tests/unittests/test_import_loading.pyimports.md

评论

支持 Markdown