Skip to content

Commit 01f6fb2

Browse files
johnteeeclaude
andcommitted
Clarify Skill as prompt-level workflow; add unified validation + enforce it in CI
Documentation/governance batch plus the review fixes: - Define "Skill = prompt-level workflow" across README, GLOSSARY, and the 9 SKILL.md files; add SKILL_INSTALLATION and cheatsheet output-convention guidance; add a reflective-minimality examples file. - Add a unified validation entry point: Makefile `all` (pytest + the 4 validators) and requirements-dev.txt. - Add CONTRIBUTING translation-completeness policy. Review fixes (so the automation actually gates what it claims to): - CI (python-tools.yml): remove job-level continue-on-error; broaden paths to reflective-prompt-library/** + Makefile + the workflow; run `make all` via requirements-dev.txt (one source of truth) instead of a partial inline pytest + single validator. - pre-commit: run `make all` over .py/.md/.yml + Makefile, not pytest-only on plans/*.py. - zh-TW cheatsheet: add the Output-conventions callout for parity with the policy introduced in the same batch. - .gitignore: strip CRLF from the new lines; keep the intentional Icon CR. Verified: make all green (52 tests + links/lint/governance/project-knowledge), both YAML files parse, git diff --check clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent feb31b6 commit 01f6fb2

24 files changed

Lines changed: 186 additions & 10 deletions

File tree

.github/workflows/python-tools.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Python Tools
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'reflective-prompt-library/**'
8+
- 'Makefile'
9+
- '.github/workflows/python-tools.yml'
10+
pull_request:
11+
paths:
12+
- 'reflective-prompt-library/**'
13+
- 'Makefile'
14+
- '.github/workflows/python-tools.yml'
15+
16+
jobs:
17+
test:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.10'
24+
- run: pip install -r reflective-prompt-library/requirements-dev.txt
25+
- run: make all

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@ Icon
2222
reflective-prompt-library/plans/route-*-results.json
2323
reflective-prompt-library/plans/benchmark-tasks.json
2424
**/__pycache__
25+
.pytest_cache/
26+
.env
27+
.venv/
28+
*.pyc

.pre-commit-config.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
repos:
2+
- repo: local
3+
hooks:
4+
- id: make-all
5+
name: make all (tests + validators)
6+
entry: make all
7+
language: system
8+
pass_filenames: false
9+
files: ^(reflective-prompt-library/.*\.(py|md|ya?ml)|Makefile)$

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,15 @@ Contributions must pass these quality gates:
158158
- **Translations** welcome - maintain both versions
159159
- See `LANGUAGE_POLICY.md` for details
160160

161+
### Translation Completeness
162+
163+
Translation files (`.zh-TW.md`) must cover:
164+
- All section headings
165+
- All code blocks
166+
- All warning, note, and callout boxes
167+
168+
Narrative sections may be summarised if a disclaimer at the top of the file notes the editorial choice. Translations that omit entire sections without an editorial note should not be merged. Existing abridged translations are grandfathered under this policy.
169+
161170
## Testing Your Changes
162171

163172
### Manual Testing

Makefile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.PHONY: test validate all
2+
3+
PLANS = reflective-prompt-library/plans
4+
5+
test:
6+
python3 -m pytest $(PLANS)/tests/ -v
7+
8+
validate:
9+
python3 $(PLANS)/validate_links.py
10+
python3 $(PLANS)/lint_skills.py
11+
python3 $(PLANS)/validate_governance.py
12+
python3 $(PLANS)/validate_project_knowledge.py
13+
14+
all: test validate

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Recommended starting points:
5454
TeaPrompt keeps prompts and workflows separate:
5555

5656
- Prompts provide nuance, judgment frames, and reusable wording.
57-
- Skills provide repeatable execution shape.
57+
- Skills provide repeatable execution shape — they are prompt-level workflow descriptors interpreted by the user's agent runtime, not a multi-agent orchestration layer.
5858
- Plans capture future code or workflow automation without overengineering the current library.
5959

6060
The workflow layer intentionally uses a small number of broad, composable skills instead of one skill per prompt.

README.zh-TW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ reflective-prompt-library/README.md
5555
TeaPrompt 將 prompts 與 workflows 分離:
5656

5757
- **Prompts** 提供細膩的判斷框架與可重用的措辭。
58-
- **Skills** 提供可重複的執行流程。
58+
- **Skills** 提供可重複的執行流程——它們是 prompt 層級的工作流程描述,由使用者的 agent runtime 解譯執行,而非多 agent 編排層
5959
- **Plans** 記錄未來程式或工作流自動化的規劃,避免過早過度設計。
6060

6161
工作流層刻意使用數量少、可組合的 broad skills,而不是每個 prompt 對應一個 skill。

reflective-prompt-library/GLOSSARY.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,3 +166,22 @@ review) with Formalization L0 (prompt-only, no runner). A routine ETL
166166
pipeline might use Strictness L1 (low rigor) with Formalization L4 (runner
167167
with deterministic gates). Always qualify bare L-level references with the taxonomy name:
168168
write "Strictness L3" or "Formalization L3", never bare "L3".
169+
170+
---
171+
172+
## Skill (Workflow Skill)
173+
174+
A reusable `SKILL.md` file that encodes a repeatable agent workflow as
175+
natural-language instructions interpreted by the host runtime.
176+
177+
**What it is:** A prompt-level workflow descriptor — a procedure for the
178+
model to follow, not a runtime module with its own process, state,
179+
messaging, or lifecycle.
180+
181+
**Operational test:** A skill can be loaded, read, and followed by any
182+
compatible agent runtime (Claude Code, Codex, OpenCode, Cursor, etc.)
183+
as a text document. If a workflow requires asynchronous messaging between
184+
independent agents, role-specific context isolation, or a persistent
185+
runtime process, a single skill alone is insufficient — those require a
186+
dedicated orchestration layer outside this library's scope. See
187+
`PROJECT_KNOWLEDGE.md` for the full list of non-goals.

reflective-prompt-library/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Core identity prompt
3131
`PROJECT_KNOWLEDGE.template.md` for project-specific design judgement.
3232
- `skills/`: concise `SKILL.md` workflow wrappers that map the prompt library into practical agent workflows.
3333
- `skills/SKILL_TRIGGER_CHEATSHEET.md`: one-page trigger cues and anti-misuse rules for the 9 workflow skills.
34-
- `skills/examples/`: two practical input/output examples per workflow skill.
34+
- `skills/examples/`: worked input/output examples for each workflow skill.
3535
- `plans/`: plan files for code-bearing or multi-agent/workflow follow-up work.
3636
- `plans/ROUTING_CONTRACT.md`: routing fairness, observability, and risk-based default-up contract.
3737
- `plans/route-001-paraphrase-eval.yaml`: paraphrase routing eval seed for ROUTE-001.
@@ -61,6 +61,8 @@ The prompt files are the source material. The `skills/` directory is the operati
6161

6262
The design intentionally avoids one skill per prompt. Use the prompt library for nuance and the skills for execution shape.
6363

64+
> Skills are prompt-level workflow wrappers: natural-language procedures interpreted by the host runtime (Claude Code, Codex, OpenCode, etc.). They do not provide a multi-agent runtime, async messaging, or role isolation.
65+
6466
## Recommended Defaults
6567

6668
Daily thinking:

reflective-prompt-library/README.zh-TW.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Doing the right thing > doing things right.
4444

4545
設計上刻意避免一個 prompt 對應一個 skill。使用 prompt library 取得細膩判斷,使用 skills 取得執行框架。
4646

47+
> Skills 是 prompt 層級的工作流程包裝:由宿主 runtime(Claude Code、Codex、OpenCode 等)解譯執行的自然語言程序。它們不提供多 agent 執行時期、非同步訊息傳遞、或角色隔離。
48+
4749
## 延伸文件
4850

4951
- 安裝: [SKILL_INSTALLATION.zh-TW.md](SKILL_INSTALLATION.zh-TW.md)

0 commit comments

Comments
 (0)