Skip to content

unit-8: add scripts/README.md#2

Merged
sent-dm merged 1 commit into
devfrom
batch/unit-8-scripts-readme
May 19, 2026
Merged

unit-8: add scripts/README.md#2
sent-dm merged 1 commit into
devfrom
batch/unit-8-scripts-readme

Conversation

@sent-dm
Copy link
Copy Markdown
Contributor

@sent-dm sent-dm commented May 19, 2026

Summary

  • Adds scripts/README.md (~55 lines) documenting the v0.3.0 script execution convention.
  • Covers what belongs in top-level scripts/ (repo-wide tooling: validate-skills.sh, run-evals.sh) vs per-skill skills/<name>/scripts/.
  • Codifies the per-skill script contract: Python 3.11+ stdlib only, --help flag, paired good.json / bad.json fixtures, clear exit codes.
  • Documents the recommended SKILL.md invocation pattern (python skills/<skill-name>/scripts/<script>.py <args> — full path from repo root) and explains why bare or relative paths break.
  • Lists the three scripts shipped in v0.3.0 (MDR funnel analyzer, 10DLC packet validator, WABA template linter).
  • Provides a checklist for adding new scripts so future authors don't drift from the convention.

Scope

Only touches scripts/README.md. No other files modified. Validator (bash scripts/validate-skills.sh) still exits 0.

Test plan

  • test -f scripts/README.md
  • wc -l scripts/README.md >= 40 (55 lines)
  • bash scripts/validate-skills.sh exits 0 (no regression — all 7 skills still pass)

Document the script execution convention for sent-skills v0.3.0:
what lives in top-level scripts/ (repo-wide tooling) vs per-skill
scripts/, the Python 3.11 stdlib-only contract, fixture and --help
requirements, the recommended SKILL.md invocation pattern, the three
shipped scripts, and the checklist for adding new ones.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@sent-dm sent-dm merged commit 328bc98 into dev May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant