Skip to content

Commit 08afe40

Browse files
committed
docs: document shipped skill payload
1 parent f246e28 commit 08afe40

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,33 @@ environment variables required.
150150

151151
---
152152

153+
## Skill Payload — What Ships to the User
154+
155+
Only `skills/python-project-workflow/` is the runtime payload. Everything else
156+
is development infrastructure — canonical reference sources, maintenance
157+
scripts, CI, and repository documentation.
158+
159+
```text
160+
skills/
161+
└── python-project-workflow/
162+
├── SKILL.md # Runtime workflow and orientation guidance
163+
└── references/
164+
├── pyproject-template.md # PEP 621 project and tooling baseline
165+
├── lint-format-typing-testing.md # Lint, format, type, test, and CI guidance
166+
├── core-footguns.md # Common Python correctness pitfalls
167+
├── safe-editing.md # Safe editing of escape-heavy content
168+
├── mature-repo-preservation.md # Preservation-first existing-repo workflow
169+
├── eval-benchmark-hardening.md # Reliable evaluation and benchmark practices
170+
└── drift-classes.md # Payload and installed-copy drift handling
171+
```
172+
173+
The payload contains Markdown instructions only: one `SKILL.md` and seven
174+
reference files. It includes no runtime scripts, configuration files, or
175+
dependencies. Copy `skills/python-project-workflow/` to the agent's skill
176+
directory, as described in Quick Start above.
177+
178+
---
179+
153180
## Portability
154181

155182
Each shipped file in `skills/` is checked by CI for agent-specific references
@@ -177,7 +204,7 @@ python3 -m ruff check scripts .github/scripts
177204

178205
---
179206

180-
## Layout
207+
## Repo Layout
181208

182209
```text
183210
python-project-workflow/

0 commit comments

Comments
 (0)