Skip to content

Commit f829126

Browse files
MinecraftFunsclaude
andcommitted
docs: Frame review vs audit distinctively and prune negations
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 565dec6 commit f829126

10 files changed

Lines changed: 50 additions & 48 deletions

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -278,15 +278,15 @@ implements the core eight, each through its own lens:
278278
| design | Plan before code exists |
279279
| build | Write new code |
280280
| refactor | Rewrite existing code, behavior preserved |
281-
| review | Findings on a diff or file set |
282-
| audit | Ranked ledger over a repository or module |
281+
| review | Judge a change: total over the diff, sound areas named |
282+
| audit | Judge a codebase: sampled by blast radius, unexamined areas named |
283283
| test | Derive checks from the lens's own laws |
284284
| teach | Explain a judgment, calibrated to audience |
285285
| help | Quick-reference card |
286286

287287
Laws:
288288

289-
* `build` and `refactor` apply changes; every other verb edits nothing.
289+
* `build` and `refactor` apply changes; every other verb is read-only.
290290
* Same verb, same contract in every persona; only the lens differs.
291291
* A read-only verb names what is outside its lens and routes it to the
292292
sibling persona's same verb in slash form.
@@ -295,8 +295,9 @@ Laws:
295295
* One verb file per invocation, registered under the verb's name.
296296

297297
Beyond the core the namespace is free (`ponytail` carries `debt` and
298-
`gain`): never give a core verb name different semantics, and never reuse
299-
another skill's verb name for a different thing. Levels are optional per
298+
`gain`), and a verb name keeps one meaning across the library: core names
299+
keep the table's semantics, and a name another skill already uses keeps
300+
that skill's meaning. Levels are optional per
300301
persona; where present they are `lite | full | ultra` meaning advise /
301302
enforce (default) / maximalist, persist until changed, and stay orthogonal
302303
to verbs.

‎pl-theorist/SKILL.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ exists.
9191
| design | Plan, model, or architect a domain before code exists |
9292
| build | Write or implement new code |
9393
| refactor | Rewrite existing code, behavior preserved (default) |
94-
| review | Read-only findings on a diff, PR, or file set |
95-
| audit | Ranked sweep of a repository or module |
94+
| review | Judge a change: read-only findings on a diff, PR, or file set |
95+
| audit | Judge a codebase: ranked, sampled sweep of a repository or module |
9696
| test | Derive tests from the code's algebra and laws |
9797
| teach | Explain a design in PL terms, calibrated to audience |
9898
| help | Quick-reference card of verbs and languages |

‎pl-theorist/references/verbs/audit.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Verb: audit
22

3-
Whole-repository or module-level sweep through the PL lens, producing a ranked
4-
ledger of modeling and cost debt. `review` judges a diff; `audit` judges a
5-
codebase. Read-only. Over-engineering and bloat route to `/ponytail audit`.
3+
Judge a codebase: whole-repository or module-level sweep through the PL
4+
lens, producing a ranked ledger of modeling and cost debt. `review` is total
5+
over a diff and gates a decision; `audit` samples by blast radius and ranks
6+
a backlog. Read-only. Over-engineering and bloat route to `/ponytail audit`.
67

78
## Pipeline
89

@@ -29,7 +30,7 @@ repo-scale categories only an audit can see:
2930
| Capability sprawl | Scripts and workflows holding broader permissions or secrets than their effects require |
3031

3132
Sample honestly: if scope forces sampling, choose by blast radius and name
32-
every area not examined.
33+
every unexamined area.
3334

3435
### 3. Rank
3536

@@ -43,16 +44,16 @@ A ledger table, ranked:
4344

4445
`| # | location | category | finding | suggested shape | effort (S/M/L) |`
4546

46-
Then: at most five lines summarizing systemic themes, the single highest-value
47-
fix, and the areas not examined. No edits; fixing proceeds through `refactor`
48-
or `build` invocations per ledger row.
47+
Then: at most five lines summarizing systemic themes, the single
48+
highest-value fix, and the unexamined areas. Fixing proceeds through
49+
`refactor` or `build` invocations per ledger row.
4950

5051
## Completion Checks
5152

5253
<verb_checklist>
53-
<item>No file was modified.</item>
54+
<item>The working tree is untouched.</item>
5455
<item>Hot paths and trust boundaries were examined before peripheral code.</item>
5556
<item>Both diff-scale and repo-scale categories were swept.</item>
5657
<item>Unexamined areas are named explicitly.</item>
57-
<item>Ranking reflects severity times reach, not discovery order.</item>
58+
<item>Ranking reflects severity times reach.</item>
5859
</verb_checklist>

‎pl-theorist/references/verbs/review.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Verb: review
22

3-
Read-only PL-lens review of a diff, PR, or file set. Produce ranked findings;
4-
change nothing. This lens hunts unsound domain modeling and unsound cost, not
5-
bloat; route over-engineering findings to `/ponytail review`.
3+
Judge a change: read-only PL-lens review of a diff, PR, or file set,
4+
total over its scope. This lens hunts unsound
5+
domain modeling and unsound cost; over-engineering findings route to
6+
`/ponytail review`.
67

78
## Pipeline
89

@@ -30,9 +31,9 @@ Sweep the scope once per category, citing file and line for each hit:
3031
### 3. Verify before reporting
3132

3233
Re-derive each candidate finding against the loaded profile's cost model and
33-
the repository's conventions. An imperative loop is not a finding when it is
34-
the honest backend; a missing `Result` is not a finding when the repository's
35-
error channel is exceptions. Drop what does not survive.
34+
the repository's conventions. An imperative loop that is the honest backend
35+
is sound; a missing `Result` where the repository's error channel is
36+
exceptions is sound. Report only what survives.
3637

3738
## Output Contract
3839

@@ -41,14 +42,14 @@ Ranked findings, most severe first, one line each:
4142
`<file:line> - <category> - <violated law or bound> - <minimal fix shape>`
4243

4344
After the list: at most three lines naming what was checked and found sound
44-
(so silence is distinguishable from omission). No edits, no patches beyond
45-
one-line fix shapes, unless the user explicitly asks to apply fixes - then
46-
switch to the `refactor` verb per finding.
45+
(so silence is distinguishable from omission). Findings and one-line fix
46+
shapes are the whole deliverable; when the user asks to apply fixes, switch
47+
to the `refactor` verb per finding.
4748

4849
## Completion Checks
4950

5051
<verb_checklist>
51-
<item>No file was modified.</item>
52+
<item>The working tree is untouched.</item>
5253
<item>Every category was swept over the full scope or the skipped remainder is named.</item>
5354
<item>Every finding survived the cost-model and convention check.</item>
5455
<item>Findings are ranked by severity with file:line anchors.</item>

‎ponytail/SKILL.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,8 @@ level - and loads nothing. Do not load reference files otherwise.
117117
| --- | --- |
118118
| design | YAGNI kill list before code: what not to build, and the rung each survivor sits on. |
119119
| refactor | Apply the cuts to existing code, behavior preserved: the shortest diff that simplifies. |
120-
| review | Over-engineering-only diff review: one line per finding, what to cut, what replaces it. |
121-
| audit | Whole-repo over-engineering audit: ranked list of what to delete, simplify, or replace. |
120+
| review | Judge a diff for smuggled complexity: one line per finding, what to cut, what replaces it. |
121+
| audit | Judge the repo's standing complexity: ranked list of what to delete, simplify, or replace. |
122122
| test | Derive the one minimal runnable check that fails if the logic breaks. |
123123
| teach | Explain a ladder decision to a named audience. |
124124
| debt | Harvest `ponytail:` shortcut comments into a tracked debt ledger. |

‎ponytail/references/audit.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# Ponytail Audit Mode
1+
# Ponytail Audit Verb
22

3-
The review verb, repo-wide. Scan the whole tree instead of a diff. Rank findings
4-
biggest cut first.
3+
Judge the codebase: scan the whole tree for standing complexity. `review`
4+
guards what a change brings in; `audit` ranks what already stands, biggest
5+
cut first.
56

67
## Tags
78

@@ -25,8 +26,7 @@ Nothing to cut: `Lean already. Ship.`
2526

2627
## Boundaries
2728

28-
Scope: over-engineering and complexity only. Correctness bugs, security
29-
holes, and performance are explicitly out of scope - route them to
30-
`/pl-theorist audit`. A single smoke test or `assert`-based self-check is
31-
the ponytail minimum, not bloat; never flag it for deletion. Lists
32-
findings, applies nothing; applying the cuts is `/ponytail refactor`.
29+
Scope: over-engineering and complexity only; correctness bugs, security
30+
holes, and performance route to `/pl-theorist audit`. A single smoke test
31+
or `assert`-based self-check is the ponytail minimum and stays. Lists
32+
findings; applying the cuts is `/ponytail refactor`.

‎ponytail/references/debt.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Ponytail Debt Mode
1+
# Ponytail Debt Verb
22

33
Every deliberate ponytail shortcut is marked with a `ponytail:` comment
44
naming its ceiling and upgrade path. This verb collects them into one ledger

‎ponytail/references/gain.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Ponytail Gain Mode
1+
# Ponytail Gain Verb
22

33
Display this scoreboard when invoked. One-shot: do NOT change level, write
44
files, or persist anything.

‎ponytail/references/help.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Ponytail Help Mode
1+
# Ponytail Help Verb
22

33
Display this reference card when invoked. One-shot: do NOT change level,
44
write files, or persist anything.

‎ponytail/references/review.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Ponytail Review Mode
1+
# Ponytail Review Verb
22

3-
Review the diff for unnecessary complexity - nothing else. One line per
4-
finding: location, what to cut, what replaces it. The diff's best outcome is
5-
getting shorter.
3+
Judge the diff for smuggled complexity, and only that. One line per
4+
finding: location, what to cut, what replaces it. The diff's best outcome
5+
is getting shorter.
66

77
## Format
88

@@ -35,8 +35,7 @@ Nothing to cut: say `Lean already. Ship.` and stop.
3535

3636
## Boundaries
3737

38-
Scope: over-engineering and complexity only. Correctness bugs, security
39-
holes, and performance are explicitly out of scope - route them to
40-
`/pl-theorist review`, not this pass. A single smoke test or `assert`-based
41-
self-check is the ponytail minimum, not bloat; never flag it for deletion.
42-
Lists findings, applies nothing; applying the cuts is `/ponytail refactor`.
38+
Scope: over-engineering and complexity only; correctness bugs, security
39+
holes, and performance route to `/pl-theorist review`. A single smoke test
40+
or `assert`-based self-check is the ponytail minimum and stays. Lists
41+
findings; applying the cuts is `/ponytail refactor`.

0 commit comments

Comments
 (0)