Skip to content

SKILL.md

Source file: 01-skills/templates/skill-with-scripts/SKILL.md. Copy it from the repository, or use the copy button on the code block.

SKILL.md
---
name: skill-with-scripts
description: >-
TODO Third-person summary, e.g. "Validates and normalises CSV exports before
import into the billing system." Use when the user works with TODO files,
asks to TODO, or mentions TODO.
compatibility: Requires Python 3.10+ (standard library only).
metadata:
version: "0.1.0"
owner: TODO
---
# TODO Skill Title
## Quick start
Run the checker on the input, fix what it reports, and repeat until it prints `OK`:
```bash
python scripts/check.py path/to/input.csv
```
## Workflow
Copy this checklist and update it as you go:
```
- [ ] 1. Run scripts/check.py on the input
- [ ] 2. Fix every reported problem
- [ ] 3. Re-run until it prints OK
- [ ] 4. Produce the output using assets/output-template.md
```
## Scripts
**`scripts/check.py`**: **run** this; don't read it. It checks the input file and prints `OK`, or prints one `ERROR:` line per problem and exits with code 1.
```bash
python scripts/check.py <file>
```
## When to read the references
- For field definitions and allowed values, read [references/reference.md](references/reference.md).
- For the output layout, use [assets/output-template.md](assets/output-template.md).
## Rules
- Never edit the source file in place; write output to a new file.
- If `check.py` reports more than 20 errors, stop and summarise them for the user instead of fixing them one by one.