Skip to content

Commit 6371004

Browse files
committed
docs: rewrite opening section for clarity and skimmability
Replace the format-first opening ("Portable... agentskills.io-compatible") with a value-first summary that a skimmer can grasp in one glance. Now covers: what the skill does, project hygiene (.gitignore/__pycache__), the py-review-skill pairing, and portability — in 14 lines instead of 28.
1 parent 4087c99 commit 6371004

1 file changed

Lines changed: 14 additions & 25 deletions

File tree

README.md

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,20 @@
55
[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
66
[![agentskills.io](https://img.shields.io/badge/agentskills.io-v1-blue)](https://agentskills.io/specification)
77

8-
Portable Python project workflow skill for agentskills.io-compatible agents.
9-
The Python 3.10+ badge covers both the project guidance and repository validation
10-
tooling; CI tests the lower bound on Python 3.10 and the current stable boundary
11-
on 3.14.
12-
13-
This repo ships an adaptive skill that handles greenfield bootstrap, tooling
14-
configuration, CI setup, packaging, mature-repo preservation, and cross-platform
15-
verification. The runtime payload contains no agent-specific commands or paths,
16-
so it remains compatible with Hermes, Claude Code, Codex, Gemini CLI, OpenCode,
17-
and any agentskills.io client.
18-
19-
- **Greenfield projects** — scaffold `pyproject.toml` (PEP 621), `src/` layout,
20-
uv, Ruff, mypy, pytest, and Google-style docstrings
21-
- **Existing projects** — discover the project's own tooling, work within its
22-
conventions. No forced migration.
23-
- **Mature repositories** — preservation-first workflow; find the native gate,
24-
respect conventions, avoid broad defaults, and report before editing
25-
- **CI/verification** — project-native gates, cross-platform tool patterns,
26-
ad-hoc verification when no gate exists
27-
- **Packaging** — build, publish, entry points, lockfile policy
28-
29-
It is not a Python code-review rule set. Pair it with
30-
[`py-review-skill`](https://github.com/CodeSigils/py-review-skill) when you want
31-
a focused review of Python correctness, maintainability, typing, testing, and
32-
common language pitfalls.
8+
**Python Project Workflow** — guides an AI agent through Python project setup,
9+
tooling, CI, packaging, and preservation.
10+
11+
This skill handles greenfield scaffolds (src layout, PEP 621, uv/Ruff/mypy/pytest),
12+
existing-project orientation, mature-repo preservation, CI configuration, packaging,
13+
and project hygiene — `.gitignore` presets, `__pycache__`/coverage/venv artifact
14+
handling, and preserving local ignore rules.
15+
16+
It does **not** review Python code. Pair it with
17+
[`py-review-skill`](https://github.com/CodeSigils/py-review-skill) for that.
18+
19+
The shipped payload is portable — no agent-specific commands or paths — so it
20+
works with Hermes, Claude Code, Codex, Gemini CLI, OpenCode, and any
21+
agentskills.io client.
3322

3423
---
3524

0 commit comments

Comments
 (0)