CodeSigils/py-review-skill
GitHub: CodeSigils/py-review-skill
为兼容 agentskills.io 的 AI 编程智能体提供可跨平台移植的模块化 Python 代码审查技能集。
Stars: 0 | Forks: 0
# py-review-skill
[](LICENSE)
[](https://github.com/CodeSigils/py-review-skill/actions)
[](https://agentskills.io/specification)
为兼容 agentskills.io 的 agent 提供的便携式 Python 代码审查技能。
本仓库包含一个路由技能以及五个专门的审查技能,涵盖类型安全、错误处理、反模式、async 模式和代码风格。
所有技能仅使用基础的 `name` + `description` frontmatter,不包含任何特定于 agent 的命令 —— 兼容 Hermes、Claude Code、Codex CLI、Gemini CLI、OpenCode 以及任何 agentskills.io 客户端。
- `py-review` — 上下文路由器:检查 Python 版本、成熟度、工具链
- `py-type-safety` — Any 泄漏、缺少注解、不安全的 Optional、泛型
- `py-error-handling` — 边界验证、泛化异常、异常链、资源清理
- `py-anti-patterns` — 硬编码配置、I/O 与逻辑混合、可变默认值
- `py-async-patterns` — 阻塞调用、缺少 await、gather、取消操作、超时
- `py-code-style` — 与工具对齐的风格、import、命名、docstring
运行时接口被刻意保持得很小:`skills/*/SKILL.md` 文件仅使用 `name` 和 `description` frontmatter,并在每个技能中内联了规则。
仓库内的本地脚本会验证内联规则 schema,提取测试用例,检查新鲜度标记,并验证 URL 的可达性。
## 快速开始
让你的 agent 能够发现该技能集。
对于支持外部技能目录的 agent,可以将配置指向 `skills/` 以实现实时更新的访问。
## 如何使用
1. **首先加载 `py-review`** — 它会检查项目的 Python 版本、成熟度、工具链以及修改过的文件,然后分发给各个子技能。
2. **子技能按需加载** — 仅激活与修改的代码相匹配的专门技能(例如:类型注解 → `py-type-safety`,async 代码 → `py-async-patterns` 等)。
3. **规则为内联形式** — 每个子技能都是一个单独的 `SKILL.md`,包含 5-7 条审查规则。没有独立的规则文件,也没有外部引用。
所有技能都是自包含的。无需任何外部设置、配置文件或环境变量。
## 本仓库包含的内容
```
py-review-skill/
├── AGENTS.md # cold-landing agent orientation
├── README.md # you are here
├── SECURITY.md # vulnerability reporting
├── LICENSE # MIT
├── .gitignore
├── pyproject.toml # project metadata + ruff config
├── test-cases.json # generated inline examples
├── docs/
│ ├── extraction-log.md # source provenance
│ └── methodology-alignment.md # design principles
├── scripts/
│ ├── validate.py # rule schema enforcement
│ ├── extract-tests.py # generate test-cases from examples
│ ├── check-expiry.py # freshness marker checks
│ └── verify-urls.py # URL reachability checks
├── .github/
│ ├── workflows/ci.yml # 5-step CI pipeline
│ └── scripts/check-portability.py # cross-agent portability gate
└── skills/
├── py-review/SKILL.md # router skill
├── py-type-safety/SKILL.md # focused: type annotations
├── py-error-handling/SKILL.md # focused: exceptions + cleanup
├── py-anti-patterns/SKILL.md # focused: correctness traps
├── py-async-patterns/SKILL.md # focused: asyncio pitfalls
└── py-code-style/SKILL.md # focused: style + tooling
```
## 可移植性
每个发布的 `SKILL.md` 都会经过 CI 检查,以排查特定于 agent 的引用(如 `skill_view`、`hermes skills`、平台适配器路径等)。如果某次提交添加了特定平台的命令,CI 会在其进入运行时之前失败。
当前的接口完全实现了跨 agent 兼容 —— 任何发布的技能文件中都没有任何平台引用。
## 验证
```
python3 scripts/validate.py # rule schema
python3 scripts/extract-tests.py --check # test-case freshness
python3 scripts/check-expiry.py # expiry markers
python3 scripts/verify-urls.py # URL reachability
python3 .github/scripts/check-portability.py # cross-agent gate
```
## 许可证
MIT — 详见 [LICENSE](LICENSE)。
Hermes Agent
``` hermes skills install CodeSigils/py-review-skill # 或者添加到 ~/.hermes/config.yaml 中的 external_dirs: # skills: # external_dirs: # - /path/to/py-review-skill/skills ```Claude Code
``` cp -r skills/* ~/.claude/skills/ ```Codex CLI
``` cp -r skills/* .codex/skills/ ```Gemini CLI / .agents/ 路径
``` cp -r skills/* .agents/skills/ ```OpenCode
``` cp -r skills/* .opencode/skills/ ```标签:Agent技能, AI智能体, Python, SOC Prime, 代码审查, 开发工具, 异步编程, 无后门, 逆向工具, 防御加固