@erclx/canon 5.73.0 → 5.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/claude/.claude-plugin/plugin.json +1 -1
- package/claude/skills/api-design/references/adopted.md +5 -3
- package/claude/skills/build-in-slices/references/adopted.md +4 -2
- package/claude/skills/code-craft/references/adopted.md +9 -7
- package/claude/skills/codebase-layout/references/adopted.md +8 -6
- package/claude/skills/create-skill/references/skill-practice.md +5 -0
- package/claude/skills/deprecation-migration/references/adopted.md +5 -3
- package/claude/skills/design-pick/references/board.md +2 -2
- package/claude/skills/plan-feature/SKILL.md +2 -1
- package/claude/skills/plan-groundwork/SKILL.md +2 -0
- package/claude/skills/pr-evidence/REQUIREMENT.md +1 -0
- package/claude/skills/pr-evidence/SKILL.md +2 -0
- package/claude/skills/pr-evidence/references/evidence.md +11 -4
- package/claude/skills/{ui-film/references/pr-clip.md → pr-evidence/references/reel.md} +21 -21
- package/claude/skills/proposal-critique/REQUIREMENT.md +34 -0
- package/claude/skills/proposal-critique/SKILL.md +126 -0
- package/claude/skills/review-craft/references/adopted.md +4 -4
- package/claude/skills/search-craft/references/adopted.md +9 -7
- package/claude/skills/systematic-debugging/references/adopted.md +4 -2
- package/claude/skills/teach-craft/references/adopted.md +8 -6
- package/claude/skills/test-craft/references/adopted.md +14 -12
- package/claude/skills/test-first/SKILL.md +1 -1
- package/claude/skills/test-first/references/adopted.md +9 -5
- package/claude/skills/ui-film/REQUIREMENT.md +4 -5
- package/claude/skills/ui-film/SKILL.md +13 -12
- package/claude/skills/ui-film/references/compose-craft.md +2 -2
- package/claude/skills/ui-film/references/handoff.md +2 -7
- package/claude/skills/write-human/references/adopted.md +8 -3
- package/docs/target/index.md +1 -0
- package/docs/target/outside-tools.md +39 -0
- package/docs/workflow/skill-map.md +1 -0
- package/governance/ledger/skills/build-in-slices/SKILL.md +55 -0
- package/governance/ledger/skills/proposal-critique/SKILL.md +66 -0
- package/governance/ledger/skills/search-craft/SKILL.md +54 -0
- package/governance/ledger/skills/systematic-debugging/SKILL.md +64 -0
- package/governance/ledger/skills/test-first/SKILL.md +28 -0
- package/governance/ledger/skills/write-human/SKILL.md +62 -0
- package/governance/ledger/skills/write-human/density.md +36 -0
- package/governance/ledger/skills/write-human/machine-tells.md +30 -0
- package/package.json +1 -1
- package/scripts/ci/docs-only.sh +24 -0
- package/src/claude/cases/misc.ts +14 -0
- package/src/claude/skills-audit.ts +89 -8
- package/src/commands/pr.ts +110 -13
- package/src/gate/measures.ts +1 -1
- package/src/gate/sequencer.ts +7 -1
- package/src/gate/stages.ts +36 -24
- package/src/markdown/scope.ts +2 -0
- package/src/pr/checks.ts +75 -3
- package/src/pr/evidence.ts +62 -1
- package/src/pr/lift.ts +23 -2
- package/src/pr/merge.ts +13 -3
- package/src/targets/pulls.ts +42 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [5.74.0](https://github.com/erclx/canon/compare/v5.73.0...v5.74.0) (2026-10-28)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **claude:** fail a source linked in both adopted.md and a ledger ([#2831](https://github.com/erclx/canon/issues/2831)) ([f5bd7bc](https://github.com/erclx/canon/commit/f5bd7bc7a42c628d9725d8559678556821b2d4ef))
|
|
9
|
+
* **gate:** run only related tests on a scoped push ([#2838](https://github.com/erclx/canon/issues/2838)) ([0918616](https://github.com/erclx/canon/commit/0918616ec6b0dcf9dea5c09da2761ca8bf0a0188))
|
|
10
|
+
* **hooks:** log each plan-guard decision to a file ([#2829](https://github.com/erclx/canon/issues/2829)) ([87da825](https://github.com/erclx/canon/commit/87da825f23163c3dca64d17f959489fba41544f8))
|
|
11
|
+
* **pr:** gate lift and merge on the base's required checks ([#2840](https://github.com/erclx/canon/issues/2840)) ([7758c02](https://github.com/erclx/canon/commit/7758c02389a0ace567ac753c59bb9baaf1c9e51d))
|
|
12
|
+
* **pr:** show why a local link or reel is missing on evidence ([#2836](https://github.com/erclx/canon/issues/2836)) ([370f0de](https://github.com/erclx/canon/commit/370f0de3dd5f2bf2c79a0b91d4173bc0ed5c1a7a))
|
|
13
|
+
* **skills:** add proposal-critique to question a proposal before build ([#2824](https://github.com/erclx/canon/issues/2824)) ([dd6e28d](https://github.com/erclx/canon/commit/dd6e28d4accde639ac5c1d7653069c44f71176ad))
|
|
14
|
+
* **skills:** audit search-craft bullets against a source ledger ([#2832](https://github.com/erclx/canon/issues/2832)) ([acd3cea](https://github.com/erclx/canon/commit/acd3ceaacf5747e2f5e78963e4cf3267ee56cb9b))
|
|
15
|
+
* **skills:** audit write-human bullets against a source ledger ([#2833](https://github.com/erclx/canon/issues/2833)) ([e78d299](https://github.com/erclx/canon/commit/e78d299f01ea470b26c61cb3ddb3246ab882502b))
|
|
16
|
+
* **skills:** check outside tools and add a canon-media bundle ([#2837](https://github.com/erclx/canon/issues/2837)) ([f32e7c3](https://github.com/erclx/canon/commit/f32e7c3ea636d6b8e84debc70d6afe1f40430536))
|
|
17
|
+
* **skills:** ledger every systematic-debugging step against a source ([#2835](https://github.com/erclx/canon/issues/2835)) ([e225b98](https://github.com/erclx/canon/commit/e225b9810d830e49276b9049d1c26f05feaac1f0))
|
|
18
|
+
* **skills:** source each build-in-slices bullet in a ledger ([#2841](https://github.com/erclx/canon/issues/2841)) ([8651b8e](https://github.com/erclx/canon/commit/8651b8ef1e2a0517c7dad0792090dab5cafbfe91))
|
|
19
|
+
* **skills:** source test-first bullets in a per-bullet ledger ([#2830](https://github.com/erclx/canon/issues/2830)) ([8d61a40](https://github.com/erclx/canon/commit/8d61a40d9e0a5faf70c3e9c753b965cea1f245d0))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Bug Fixes
|
|
23
|
+
|
|
24
|
+
* **hooks:** track plan-guard.sh as executable and test hook modes ([#2826](https://github.com/erclx/canon/issues/2826)) ([d1ac3f5](https://github.com/erclx/canon/commit/d1ac3f543c7b1cad038871f5acaa71cb9889085c))
|
|
25
|
+
|
|
3
26
|
## [5.73.0](https://github.com/erclx/canon/compare/v5.72.1...v5.73.0) (2026-10-28)
|
|
4
27
|
|
|
5
28
|
|
|
@@ -7,21 +7,23 @@ description: Which external API design sources this skill adopted, which it decl
|
|
|
7
7
|
|
|
8
8
|
External sources were read and filtered rather than imported. This file is the record, and a later session extending the skill adds to it rather than re-arguing an item settled here.
|
|
9
9
|
|
|
10
|
+
A source a bullet rests on is linked once, in that bullet's row of the toolkit's per-bullet ledger at `governance/ledger/skills/api-design/`, which ships outside the plugin. This file names those sources without the link and keeps the catalog-level adopted and declined record, linking only a source no row cites.
|
|
11
|
+
|
|
10
12
|
## Adopted from the default shelf
|
|
11
13
|
|
|
12
14
|
### Observable behavior
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
Software Engineering at Google, ch. 1 states Hyrum's Law, that with enough users, every observable behavior of a system is depended on by somebody, whatever the contract promises.
|
|
15
17
|
|
|
16
18
|
Adopted as the opening group, stated as design rules rather than as an observation, so a session decides what is observable before a caller decides it for them. Ordering and timing are named because the chapter's own examples are hash iteration order and timing.
|
|
17
19
|
|
|
18
20
|
### One version per dependency
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
Software Engineering at Google, ch. 16 states the One-Version Rule, keeping one version of each dependency in a repository, so a change to it migrates every caller rather than leaving two versions live. Adopted under additive change for a caller that cannot pin, which is any module imported from inside one repository.
|
|
21
23
|
|
|
22
24
|
## Adopted from one external skill
|
|
23
25
|
|
|
24
|
-
From `addyosmani/agent-skills@2686b620`,
|
|
26
|
+
From `addyosmani/agent-skills@2686b620`, `skills/api-and-interface-design/SKILL.md`.
|
|
25
27
|
|
|
26
28
|
### Contract and errors
|
|
27
29
|
|
|
@@ -7,17 +7,19 @@ description: Which external sources on incremental building this skill adopted,
|
|
|
7
7
|
|
|
8
8
|
External sources were read and filtered rather than imported. This file is the record, and a later session extending the skill adds to it rather than re-arguing an item settled here.
|
|
9
9
|
|
|
10
|
+
A source a bullet rests on is linked once, in that bullet's row of the toolkit's per-bullet ledger at `governance/ledger/skills/build-in-slices/`, which ships outside the plugin. This file names those sources without the link and keeps the catalog-level adopted and declined record, linking only a source no row cites.
|
|
11
|
+
|
|
10
12
|
## Adopted from the default shelf
|
|
11
13
|
|
|
12
14
|
### Small changes
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
Small CLs, from Google's engineering practices, keeps a change self-contained and about one thing, puts a refactor in a change apart from the feature needing it, and puts a test in the same change as its code.
|
|
15
17
|
|
|
16
18
|
Adopted as the rule that each commit carries one logical change, the refactor excuse row, and the rule that a slice's test never lands after its code.
|
|
17
19
|
|
|
18
20
|
## Adopted for the increment cycle
|
|
19
21
|
|
|
20
|
-
Addy Osmani's `agent-skills`, pinned at addyosmani/agent-skills@2686b620,
|
|
22
|
+
Addy Osmani's `agent-skills`, pinned at addyosmani/agent-skills@2686b620, `skills/incremental-implementation/SKILL.md`, supplies the cycle and most of the rules.
|
|
21
23
|
|
|
22
24
|
### The cycle and its rules
|
|
23
25
|
|
|
@@ -7,11 +7,13 @@ description: Which external software design sources this skill adopted, which it
|
|
|
7
7
|
|
|
8
8
|
External sources were read and filtered rather than imported. This file is the record, and a later session extending the skill adds to it rather than re-arguing an item settled here.
|
|
9
9
|
|
|
10
|
+
A source a bullet rests on is linked once, in that bullet's row of the toolkit's per-bullet ledger at `governance/ledger/skills/code-craft/`, which ships outside the plugin. This file names those sources without the link and keeps the catalog-level adopted and declined record, linking only a source no row cites.
|
|
11
|
+
|
|
10
12
|
## Adopted from the default shelf
|
|
11
13
|
|
|
12
14
|
### What to look for in a code review
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
Google's engineering practices say to solve the problem known to need solving now rather than one speculated about, and to read "too complex" as "cannot be understood quickly by a reader".
|
|
15
17
|
|
|
16
18
|
Adopted as the writing-time half of the same judgment, behind the change test and the ban on building for an unnamed case. The review procedure itself stays with `review-craft`.
|
|
17
19
|
|
|
@@ -29,25 +31,25 @@ Adopted as the opening of the depth group and the pass-through flag. `api-design
|
|
|
29
31
|
|
|
30
32
|
### The design book exchange
|
|
31
33
|
|
|
32
|
-
In
|
|
34
|
+
In John Ousterhout and Robert Martin's discussion, Martin argues for very small methods and Ousterhout for fewer, deeper ones a reader need not stitch together.
|
|
33
35
|
|
|
34
36
|
Adopted as the third tension, stated as when each side wins rather than as a verdict, plus the depth bullet preferring one function a reader follows top to bottom.
|
|
35
37
|
|
|
36
38
|
### Reducing coupling
|
|
37
39
|
|
|
38
|
-
Martin Fowler,
|
|
40
|
+
Martin Fowler, Reducing Coupling, IEEE Software, 2001, holds that a change in one module should not ripple into others. Adopted behind the rule that a decision stays in one unit and the red flag on a third file opened to adjust one rule.
|
|
39
41
|
|
|
40
42
|
## Adopted for the tensions
|
|
41
43
|
|
|
42
44
|
### DRY as knowledge
|
|
43
45
|
|
|
44
|
-
Andy Hunt and Dave Thomas,
|
|
46
|
+
Andy Hunt and Dave Thomas, Orthogonality and the DRY Principle, give every piece of knowledge one authoritative representation, which is broader than and different from avoiding repeated text.
|
|
45
47
|
|
|
46
48
|
Adopted as the first tension, with its other side stated. Two blocks that only look alike and change for different reasons stay apart.
|
|
47
49
|
|
|
48
50
|
### Yagni and its carve-out
|
|
49
51
|
|
|
50
|
-
Ron Jeffries, [You're NOT Gonna Need It](https://ronjeffries.com/xprog/articles/practices/pracnotneed/), and Martin Fowler,
|
|
52
|
+
Ron Jeffries, [You're NOT Gonna Need It](https://ronjeffries.com/xprog/articles/practices/pracnotneed/), and Martin Fowler, Yagni, build no capability for a presumptive feature, though Yagni "does not apply to effort to make the software easier to modify".
|
|
51
53
|
|
|
52
54
|
Adopted as the second tension, with Fowler's carve-out as the side that wins for a refactor, a test, or a parameter serving the asked-for code.
|
|
53
55
|
|
|
@@ -63,11 +65,11 @@ Martin Fowler, [Beck Design Rules](https://martinfowler.com/bliki/BeckDesignRule
|
|
|
63
65
|
|
|
64
66
|
### Injection
|
|
65
67
|
|
|
66
|
-
Martin Fowler,
|
|
68
|
+
Martin Fowler, Inversion of Control Containers and the Dependency Injection pattern, hands a component what it depends on rather than letting it find it. Adopted as the hidden-inputs rule for the clock, the environment, randomness, and globals, without any container.
|
|
67
69
|
|
|
68
70
|
## Adopted for agent failure modes
|
|
69
71
|
|
|
70
|
-
Birgitta Böckeler,
|
|
72
|
+
Birgitta Böckeler, The role of developer skills in agentic coding, 2025, and How far can we push AI autonomy in code generation?, 2025.
|
|
71
73
|
|
|
72
74
|
- Together they record a lack of reuse and modularity, overeagerness that builds unrequested features, assumptions filled in for silent requirements, and brute-force fixes
|
|
73
75
|
- Adopted as the closing concern group, worded as checks on the session's own diff
|
|
@@ -7,39 +7,41 @@ description: Which external layout patterns this skill adopted, which it decline
|
|
|
7
7
|
|
|
8
8
|
External sources were read and filtered rather than imported. This file is the record, and a later session extending the skill adds to it rather than re-arguing an item settled here.
|
|
9
9
|
|
|
10
|
+
A source a bullet rests on is linked once, in that bullet's row of the toolkit's per-bullet ledger at `governance/ledger/skills/codebase-layout/`, which ships outside the plugin. This file names those sources without the link and keeps the catalog-level adopted and declined record, linking only a source no row cites.
|
|
11
|
+
|
|
10
12
|
## Adopted for placing files
|
|
11
13
|
|
|
12
14
|
### Group what changes together
|
|
13
15
|
|
|
14
|
-
Robert Martin's restatement of the single responsibility principle reads "Gather together the things that change for the same reasons. Separate those things that change for different reasons" (
|
|
16
|
+
Robert Martin's restatement of the single responsibility principle reads "Gather together the things that change for the same reasons. Separate those things that change for different reasons" (The Single Responsibility Principle).
|
|
15
17
|
|
|
16
18
|
It gives "split by role" a test a planner can apply to a folder, which is whether these files would change together.
|
|
17
19
|
|
|
18
20
|
### Name folders for the domain rather than the framework
|
|
19
21
|
|
|
20
|
-
Martin's
|
|
22
|
+
Martin's Screaming Architecture argues the top level should tell readers "about the system, not about the frameworks you used in your system". It is the root of naming a folder for what it holds rather than its technical kind.
|
|
21
23
|
|
|
22
24
|
### Feature folders, no cross-feature imports, one-way flow
|
|
23
25
|
|
|
24
|
-
bulletproof-react puts most code under per-feature folders holding only the subfolders each needs, forbids one feature importing another, and enforces a shared, then features, then app direction with an import-path lint rule (
|
|
26
|
+
bulletproof-react puts most code under per-feature folders holding only the subfolders each needs, forbids one feature importing another, and enforces a shared, then features, then app direction with an import-path lint rule (project structure).
|
|
25
27
|
|
|
26
28
|
Adopted as the direction rule in the body and the feature-folder guidance in `frontend.md`, without the mandate.
|
|
27
29
|
|
|
28
30
|
### Grow in levels and promote on the second consumer
|
|
29
31
|
|
|
30
|
-
Robin Wieruch grows a project from one file to feature folders, each level triggered by a named event rather than a count, and moves a helper to the shared layer once two or more features need it (
|
|
32
|
+
Robin Wieruch grows a project from one file to feature folders, each level triggered by a named event rather than a count, and moves a helper to the shared layer once two or more features need it (React folder structure).
|
|
31
33
|
|
|
32
34
|
Adopted as the promotion rule in the body and the levels in `frontend.md`.
|
|
33
35
|
|
|
34
36
|
### Consistency over any one strategy
|
|
35
37
|
|
|
36
|
-
The Next.js docs call the framework unopinionated about organization, list three strategies, and ask a project to "choose a strategy that works for you and your team and be consistent across the project" (
|
|
38
|
+
The Next.js docs call the framework unopinionated about organization, list three strategies, and ask a project to "choose a strategy that works for you and your team and be consistent across the project" (project structure).
|
|
37
39
|
|
|
38
40
|
Adopted as the body's first section, reading and keeping the project's own strategy.
|
|
39
41
|
|
|
40
42
|
### Fixtures in modules, page objects on their own
|
|
41
43
|
|
|
42
|
-
Playwright defines fixtures in dedicated modules that extend the base test, merges them into one module the specs import, and keeps page objects as their own modules (
|
|
44
|
+
Playwright defines fixtures in dedicated modules that extend the base test, merges them into one module the specs import, and keeps page objects as their own modules (fixtures). Adopted in `tests.md` as the split between specs and support.
|
|
43
45
|
|
|
44
46
|
## Adopted for closing the body
|
|
45
47
|
|
|
@@ -55,7 +55,12 @@ A skill whose files list outside-practice directives one per bullet takes a ledg
|
|
|
55
55
|
- Exempt by name a checklist restating rules a ledgered file sources, which would cite each source twice, and a glossary, whose definitions direct nothing
|
|
56
56
|
- Mark the skill's `SKILL.md` for a ledger too when the body carries directives of its own
|
|
57
57
|
- Keep the rows outside the plugin, so a target pays nothing for them
|
|
58
|
+
|
|
59
|
+
Two copies of one source drift, and the audit holds the move.
|
|
60
|
+
|
|
58
61
|
- Move a source out of `adopted.md` once its row lands in a ledger, since two copies drift on the first edit. `adopted.md` keeps the catalog-level record and the sources behind any unledgered file.
|
|
62
|
+
- Expect the audit to fail a link in both `adopted.md` and one of the skill's ledgers. It reads an anchor or a trailing slash as the same page and two commit pins as two pages.
|
|
63
|
+
- Name the ledger folder in `adopted.md` once every link has moved out, since a record with no link and no `House choice` row otherwise reads as citing nothing
|
|
59
64
|
|
|
60
65
|
The audit counts a few lines in a ledgered file apart from a rule's.
|
|
61
66
|
|
|
@@ -7,11 +7,13 @@ description: Which external sources on deprecation and migration this skill adop
|
|
|
7
7
|
|
|
8
8
|
External sources were read and filtered rather than imported. This file is the record, and a later session extending the skill adds to it rather than re-arguing an item settled here.
|
|
9
9
|
|
|
10
|
+
A source a bullet rests on is linked once, in that bullet's row of the toolkit's per-bullet ledger at `governance/ledger/skills/deprecation-migration/`, which ships outside the plugin. This file names those sources without the link and keeps the catalog-level adopted and declined record, linking only a source no row cites.
|
|
11
|
+
|
|
10
12
|
## Adopted from the default shelf
|
|
11
13
|
|
|
12
14
|
### Deprecation
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
Software Engineering at Google, chapter 15 supplies four positions the body states.
|
|
15
17
|
|
|
16
18
|
- **Two types.** Advisory and compulsory, the second carrying a removal date. The body allows compulsory only once a replacement ships, which the chapter implies and the four questions make explicit.
|
|
17
19
|
- **Actionable, relevant warnings.** A warning names what the caller does, and surfaces where the caller uses the old surface.
|
|
@@ -20,13 +22,13 @@ External sources were read and filtered rather than imported. This file is the r
|
|
|
20
22
|
|
|
21
23
|
### Migrating callers yourself
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
Software Engineering at Google, chapter 1, under "Policies That Don't Scale", has infrastructure teams move their internal users to new versions themselves, or update in place in a backward-compatible way.
|
|
24
26
|
|
|
25
27
|
Adopted as the group on migrating callers yourself, with the backward-compatible path kept for callers the owner cannot edit.
|
|
26
28
|
|
|
27
29
|
## Adopted for the decision and the bridges
|
|
28
30
|
|
|
29
|
-
Addy Osmani's `agent-skills`, pinned at addyosmani/agent-skills@2686b620,
|
|
31
|
+
Addy Osmani's `agent-skills`, pinned at addyosmani/agent-skills@2686b620, `skills/deprecation-and-migration/SKILL.md`, supplies the decision and the bridge patterns.
|
|
30
32
|
|
|
31
33
|
### The decision
|
|
32
34
|
|
|
@@ -13,8 +13,8 @@ Resolve `<board>` and `<project>` from the `board` and `project` keys of `canon/
|
|
|
13
13
|
Resolve `<board>` against the main worktree root, the way `session-worktree` resolves it, since a linked worktree holds no copy of the gitignored folder.
|
|
14
14
|
|
|
15
15
|
- Pass `--root <board> --project <project> --json` to every verb unless the step says otherwise, so no verb relies on the only-project default
|
|
16
|
-
- Where `frameboard` is not on PATH, run every verb as `bunx -y frameboard
|
|
17
|
-
- The
|
|
16
|
+
- Where `frameboard` is not on PATH, run every verb as `bunx -y frameboard <verb>`. Say so once and keep that form for the run.
|
|
17
|
+
- The fallback takes the latest release unpinned, since the verbs and record shapes come from `frameboard docs --json` each run and a renamed verb surfaces as a refusal
|
|
18
18
|
|
|
19
19
|
Run `frameboard docs --json` before writing the first frame. Its `contentFormat` fixes what a frame may hold and link, and its `exitCodes` name every refusal a verb can return.
|
|
20
20
|
|
|
@@ -77,7 +77,8 @@ What this skill adds on top of the standard:
|
|
|
77
77
|
- Record each command Step 2 ran and what it showed, or the not-run reason, under `## Current behavior`, and omit the section when nothing ran
|
|
78
78
|
- Reframe a vague ask as success criteria before `## Files to touch`, each an observable result and its check, which becomes one `## Verification` bullet. "Make it faster" names none.
|
|
79
79
|
- Confirm a concrete project or use case drives the feature, and lift patterns from it where precedent exists. A feature with no named user is a guess.
|
|
80
|
-
- Prefer one layout that serves both a new and a grown project over a dual-mode toggle or a migration shim. Two modes double what every later change
|
|
80
|
+
- Prefer one layout that serves both a new and a grown project over a dual-mode toggle or a migration shim. Two modes double what every later change holds.
|
|
81
|
+
- Name `proposal-critique` for a one-way change or an unverified cause
|
|
81
82
|
|
|
82
83
|
### Suggestions and sections
|
|
83
84
|
|
|
@@ -134,6 +134,8 @@ The standard sets the open question format inside a topic file and in `00-scope.
|
|
|
134
134
|
|
|
135
135
|
Aside from an experiment fixture, Steps 4 and 5 are the only ways close mode reaches outside the folder. Do not close while an open question quietly fails an outcome. Resolve it, or record it in `06-decision.md` as knowingly accepted.
|
|
136
136
|
|
|
137
|
+
Name `proposal-critique` in the close report when the decision is a one-way change or a fix whose cause is unverified, and never invoke it from here.
|
|
138
|
+
|
|
137
139
|
## Check the folder
|
|
138
140
|
|
|
139
141
|
Run `canon records validate groundwork <nn>-<slug>` on the folder this run wrote, in every mode, before reporting. Fix each entry its `structure` array names, against `### Structure` in `${CLAUDE_SKILL_DIR}/../plan-feature/references/plan.md`.
|
|
@@ -32,3 +32,4 @@ A session judging from the diff whether an evidence image changed cannot see a r
|
|
|
32
32
|
- The title, body, labels, and pre-publish scan, which `git-pr` owns
|
|
33
33
|
- Writing the checklist, which `ui-checklist` owns, leaving this skill to consume the handoff file and remove it after posting
|
|
34
34
|
- Driving the checklist in the running app, which `review-ui` owns
|
|
35
|
+
- The filming rules the reel follows, which `ui-film` owns
|
|
@@ -48,6 +48,8 @@ Collect only the lines below whose condition holds, and nothing when none does.
|
|
|
48
48
|
| The reel step skipped with a reason | `🎞️ No reel: <reason>: <message>` |
|
|
49
49
|
| A git refusal or a preview refusal the reference reports | `⚠️ <reason>: <message>` |
|
|
50
50
|
|
|
51
|
+
The no-local-preview and no-reel lines also land on the evidence comment, through the evidence call's `--local-skip` and `--reel-skip`, so the pull request shows why a link or a reel is missing after the session's report scrolls away.
|
|
52
|
+
|
|
51
53
|
### The uncaptured line
|
|
52
54
|
|
|
53
55
|
Collect `📸 <N> painted paths changed with no evidence capture. Recapture and push.` when the evidence record lists `uncaptured` paths, with `<N>` its count. The line never stops the run, since no step here can take a capture, and the review raises the same paths as a finding until a recapture lands.
|
|
@@ -36,7 +36,7 @@ canon pr local --json
|
|
|
36
36
|
The verb reports the lowest port serving an HTML page whose process runs inside this worktree, never one in another worktree or the main checkout, which shows a different branch. `canon pr local --help` states the contract. Read `reason` on the record rather than the exit code.
|
|
37
37
|
|
|
38
38
|
- `ok`: hold the record's `url` for the evidence step below.
|
|
39
|
-
- `no-server`, `no-listener-reader`, `unhealthy`, or `invalid-config`: hold the reason and the record's `message` for the closing report
|
|
39
|
+
- `no-server`, `no-listener-reader`, `unhealthy`, or `invalid-config`: hold the reason and the record's `message` for the closing report and for the evidence step's `--local-skip`, and pass no link.
|
|
40
40
|
- `unhealthy` means a page answered but a health path declared in `canon/config/local.toml` failed. `invalid-config` means that file cannot be read, so nothing was checked.
|
|
41
41
|
- Never start a server here, since the ship chain cannot own one. A worker starts one under `role-worker`.
|
|
42
42
|
- Anything else, including no record or an older binary's unknown-subcommand error: move on silently, as a skip rather than a stop.
|
|
@@ -63,12 +63,14 @@ canon pr evidence <number> --check --json
|
|
|
63
63
|
- Skip filming when the record's `reel.head` is a prefix of the `tip` that `canon pr head <number> --json` reports, since the posted reel already shows this head
|
|
64
64
|
- With no checklist from either source, skip silently, since nothing names an interaction to film
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
Read `${CLAUDE_SKILL_DIR}/references/reel.md` and run it with the number, the local `url`, and the checklist. It films, checks each beat's closing still, pushes the reel to `canon/frames`, and hands back a `link` or a skip reason.
|
|
67
67
|
|
|
68
|
-
Report it rather than proceeding silently when `
|
|
68
|
+
It reads the filming rules in `ui-film`. Report it rather than proceeding silently when the `ui-film` skill does not resolve, and post the evidence without a reel.
|
|
69
69
|
|
|
70
70
|
- Hold a `link` for the evidence step, which embeds it under the addresses
|
|
71
|
-
- Hold a skip's reason and message for the closing report
|
|
71
|
+
- Hold a skip's reason and message for the closing report and for the evidence step's `--reel-skip`
|
|
72
|
+
- A skip never stops the chain, and a reel already on the comment carries forward under the older head it names
|
|
73
|
+
- A silent skip holds no reason, so it passes no `--reel-skip`
|
|
72
74
|
|
|
73
75
|
## Post the evidence comparison
|
|
74
76
|
|
|
@@ -78,6 +80,11 @@ Run the verb once against the pull request number. Pass `--checklist` when the c
|
|
|
78
80
|
canon pr evidence <number> --checklist <main-root>/.canon/tmp/handoff/ui-checklist/<slug>.md --local <url> --reel <link> --json
|
|
79
81
|
```
|
|
80
82
|
|
|
83
|
+
Pass `--local-skip '<reason>: <message>'` in place of `--local` when the local step held a refusal, and `--reel-skip '<reason>: <message>'` in place of `--reel` when the reel step held a skip. Each puts the line the closing report prints onto the comment as well, so a reader of the pull request sees why the link or the reel is missing.
|
|
84
|
+
|
|
85
|
+
- Pass the same text the closing report carries, so the comment and the report agree
|
|
86
|
+
- A later run that posts the link or films the reel drops the line, and one passing neither flag carries it forward
|
|
87
|
+
|
|
81
88
|
One call answers both questions because a checklist decides `no-evidence`. A diff carrying a checklist and no evidence image renders `ok` with the checklist in a marked body, so the checklist lands in the one comment a later call finds and edits.
|
|
82
89
|
|
|
83
90
|
- Pass `--checklist` only for a file that exists
|
|
@@ -1,31 +1,31 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
description:
|
|
2
|
+
title: Reel
|
|
3
|
+
description: The reel pr-evidence films for an evidence comment with no operator present, covering the beat choice from the checklist, the length cap, the still check that stands in for approval, the reel flag, and the push to the frames branch
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
#
|
|
6
|
+
# Reel
|
|
7
7
|
|
|
8
|
-
Read
|
|
8
|
+
Read by the reel step of `evidence.md`, passing the pull request number, the `url` its `canon pr local` read returned, and the checklist text.
|
|
9
9
|
|
|
10
|
-
This
|
|
10
|
+
This file films a short reel of what the checklist asks a reviewer to try, hosts it on `canon/frames`, and hands back the link or the reason it skipped. The filming rules are `ui-film`'s, in `${CLAUDE_SKILL_DIR}/../ui-film/references/take-craft.md`, and so is the config's `access` value, in `${CLAUDE_SKILL_DIR}/../ui-film/references/config.md`.
|
|
11
11
|
|
|
12
12
|
## Contents
|
|
13
13
|
|
|
14
|
-
- [
|
|
14
|
+
- [How the reel runs](#how-the-reel-runs)
|
|
15
15
|
- [Choose the beats](#choose-the-beats)
|
|
16
16
|
- [Film the reel](#film-the-reel)
|
|
17
17
|
- [Check each still](#check-each-still)
|
|
18
18
|
- [Push the reel](#push-the-reel)
|
|
19
|
-
- [What goes back to the
|
|
19
|
+
- [What goes back to the reel step](#what-goes-back-to-the-reel-step)
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## How the reel runs
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
No operator is present, so the run is unattended end to end.
|
|
24
24
|
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
- Write inside `.canon/tmp/
|
|
25
|
+
- Film the address the caller passed, joined to the config's `access` value, and start no server
|
|
26
|
+
- Approve nothing. The beats come from a checklist a reviewer already reads, and the still check below is the guard against posting a wrong take.
|
|
27
|
+
- Compose nothing, since the reel is the product
|
|
28
|
+
- Write inside `.canon/tmp/pr/reel/<number>/` at the current worktree's root, since a reel is thrown away once posted
|
|
29
29
|
- Ask nothing at any step. Every stop below is a skip with a reason, since the ship chain runs this with nobody to answer.
|
|
30
30
|
|
|
31
31
|
## Choose the beats
|
|
@@ -56,7 +56,7 @@ A checklist with one group gives up to three beats from it. A checklist with fou
|
|
|
56
56
|
Write one plan entry for each beat chosen, then skip when none was.
|
|
57
57
|
|
|
58
58
|
- Name each beat after its box's text, cut to the action
|
|
59
|
-
- Write the plan per `${CLAUDE_SKILL_DIR}/references/take-craft.md`, finding each target on the served page rather than guessing it
|
|
59
|
+
- Write the plan per `${CLAUDE_SKILL_DIR}/../ui-film/references/take-craft.md`, finding each target on the served page rather than guessing it
|
|
60
60
|
- With no interactive box, skip as `no-interactive-box` and film nothing
|
|
61
61
|
- With interactive boxes that the filter removed, whether negative, static, or marked `(taste)`, skip as `no-visible-change` and film nothing
|
|
62
62
|
|
|
@@ -67,7 +67,7 @@ Keep the whole reel at or under 12 seconds. Each beat opens and closes on a 0.6
|
|
|
67
67
|
## Film the reel
|
|
68
68
|
|
|
69
69
|
```bash
|
|
70
|
-
canon take <url> .canon/tmp/
|
|
70
|
+
canon take <url> .canon/tmp/pr/reel/<number>/plan.json --out .canon/tmp/pr/reel/<number>/takes --reel .canon/tmp/pr/reel/<number>/reel.webp --json
|
|
71
71
|
```
|
|
72
72
|
|
|
73
73
|
Branch on the record's `reason`, never on the exit code.
|
|
@@ -86,23 +86,23 @@ Open each beat's `still.jpg`, the closing frame the record names in its `still`
|
|
|
86
86
|
|
|
87
87
|
- A still showing the wrong state skips the reel as `wrong-state`, naming the beat and what the still shows
|
|
88
88
|
- A record whose beats carry no `still` field comes from a `canon` predating the still, so skip as `no-still` rather than posting a reel nothing checked
|
|
89
|
-
- Read `fallback` on each beat
|
|
89
|
+
- Read `fallback` on each beat. A beat filmed by screencast still joins the reel, since the reel shrinks every beat to one width.
|
|
90
90
|
|
|
91
91
|
## Push the reel
|
|
92
92
|
|
|
93
93
|
Stamp the pass in compact UTC and push the file:
|
|
94
94
|
|
|
95
95
|
```bash
|
|
96
|
-
canon pr frames <number> --reel .canon/tmp/
|
|
96
|
+
canon pr frames <number> --reel .canon/tmp/pr/reel/<number>/reel.webp --pass "$(date -u +%Y%m%dT%H%M%SZ)" --json
|
|
97
97
|
```
|
|
98
98
|
|
|
99
99
|
- `ok`: hold the record's `link`
|
|
100
100
|
- `reel-too-large`: skip as `reel-too-large`, since GitHub would not render it
|
|
101
101
|
- Any other `reason`: skip under it with the record's `message`
|
|
102
102
|
|
|
103
|
-
## What goes back to the
|
|
103
|
+
## What goes back to the reel step
|
|
104
104
|
|
|
105
|
-
Hand
|
|
105
|
+
Hand the reel step one of two things and print nothing of your own:
|
|
106
106
|
|
|
107
|
-
- The `link` from the push, which
|
|
108
|
-
- A skip, as the reason and a one-line message, which
|
|
107
|
+
- The `link` from the push, which the evidence step passes to `canon pr evidence --reel`
|
|
108
|
+
- A skip, as the reason and a one-line message, which the closing report names
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: proposal-critique
|
|
3
|
+
description: Scope boundary for questioning a proposal before it is built, the two directions it checks, and the one verdict it ends on
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Proposal critique requirement
|
|
7
|
+
|
|
8
|
+
## Gap
|
|
9
|
+
|
|
10
|
+
Without this skill, a session builds a proposal as stated. A fix for an upstream failure ships before anyone checks whether the cause is ours. A proposal that holds back too far, such as a gate serializing work it never needed to hold, passes too, since an improvised critique asks only whether a change does too much.
|
|
11
|
+
|
|
12
|
+
When a session does question a proposal, it asks the same long list of a one-line revertible edit and of a published release, so it either stalls small work or waves through large work. It ends on a list of concerns with no call, and it answers from its own reading of the conversation without saying the proposal was its own.
|
|
13
|
+
|
|
14
|
+
## Must
|
|
15
|
+
|
|
16
|
+
- Ask whether the proposal does too much and whether it is too cautious
|
|
17
|
+
- Scale the question count by reversibility and reach, two questions for a two-way local change and every group for a one-way or shipped change or an unverified cause
|
|
18
|
+
- Answer each question from evidence in the tree, the history, or the record, and put a preference question through the question surface
|
|
19
|
+
- End on exactly one verdict of go, probe first, absorb, or stop, naming the questions that decided it
|
|
20
|
+
- Say where the proposal was read from, and say when this session wrote it
|
|
21
|
+
|
|
22
|
+
## Must not
|
|
23
|
+
|
|
24
|
+
- Write a section into the plan, task, or intake item it critiques, since the operator decides what moves into a record
|
|
25
|
+
- Run on its own initiative or from another skill by default
|
|
26
|
+
- Stay in the catalog if the operator and the planning skills' pointers never reach it at the costly moment, which is the review criterion for whether it earns its place
|
|
27
|
+
- Give a conditional verdict, which is a probe stated as a go
|
|
28
|
+
|
|
29
|
+
## Out of scope
|
|
30
|
+
|
|
31
|
+
- Batching decisions that turn on the operator's preference, which `decision-escalate` owns
|
|
32
|
+
- Investigating a failing test or a bug in hand, which `systematic-debugging` owns
|
|
33
|
+
- Judging a finished change, which `review-pr` owns
|
|
34
|
+
- Writing the plan a go lets through, which `plan-feature` owns
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: proposal-critique
|
|
3
|
+
description: Questions a plan, a fix, a triage call, or a feature ask before it is built, in both directions, whether it does too much and whether it is too cautious, scaling the questions to how reversible the change is and how far it reaches, and ends on one verdict of go, probe first, absorb, or stop. Use when asked to "critique this plan", "poke holes in this", "is this fix worth it", "should we even build this", "challenge this proposal", or "is the cause actually ours". Do NOT use to batch open decisions that turn on the operator's preference, which is `decision-escalate`, to investigate a failing test, which is `systematic-debugging`, or to review a finished change, which is `review-pr`. Do NOT auto-trigger.
|
|
4
|
+
metadata:
|
|
5
|
+
family: decide
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Proposal critique
|
|
9
|
+
|
|
10
|
+
Question a proposal before anything is built from it, answer each question with evidence from the tree or the record, and end on one verdict.
|
|
11
|
+
|
|
12
|
+
A proposal fails two ways. It does too much, fixing a cause nobody showed is ours, or it holds back so far that the work it guards stalls. Ask both.
|
|
13
|
+
|
|
14
|
+
## Guards
|
|
15
|
+
|
|
16
|
+
- If no proposal is named and the conversation holds none, stop: `❌ Nothing to critique. Name a plan, an issue, or the proposal in a sentence.`
|
|
17
|
+
- Critique only what is not built yet. A finished change is a review, so stop and name `review-pr`.
|
|
18
|
+
- Write nothing into the proposal or any other record. The verdict goes to chat, and the operator decides what moves into a record.
|
|
19
|
+
|
|
20
|
+
## Step 1: read the proposal
|
|
21
|
+
|
|
22
|
+
Read it from its written record where one exists, being a plan path, an issue, a task, or an intake item. Read every file it names before asking anything.
|
|
23
|
+
|
|
24
|
+
- Say in the output that it was read from the conversation when no record exists, since a restated proposal drifts from the one asked for
|
|
25
|
+
- Say in the output when this session wrote the proposal, since a critique by its author is the weak form and catches less than an independent read
|
|
26
|
+
- Read the project's requirements record where one exists, since two questions test the proposal against its goals and non-goals
|
|
27
|
+
|
|
28
|
+
## Step 2: size the critique
|
|
29
|
+
|
|
30
|
+
Rate the proposal on two axes before asking anything, and let the rating set how many questions run.
|
|
31
|
+
|
|
32
|
+
- Reversibility: a two-way change is undone by a revert with nothing left behind, and a one-way change leaves state, a published release, a migration, or a habit a revert cannot reach
|
|
33
|
+
- Reach: a local change touches one surface in this repository, and a shipped change reaches targets, other repositories, or other people's work
|
|
34
|
+
|
|
35
|
+
| Rating | Groups to ask |
|
|
36
|
+
| ----------------------------- | ----------------------------------------------------- |
|
|
37
|
+
| Two-way and local | Real problem only, its first two questions, then stop |
|
|
38
|
+
| One-way, or shipped | Every group |
|
|
39
|
+
| A fix for an unverified cause | Every group, whatever the rating, starting with cause |
|
|
40
|
+
|
|
41
|
+
State the rating and its reason in one line. Never run the full set on a two-way local change to look thorough.
|
|
42
|
+
|
|
43
|
+
## Step 3: ask in both directions
|
|
44
|
+
|
|
45
|
+
Answer each question from evidence found in the tree, the history, CI, or the record, quoting what was found. A question nothing answers is answered as unknown, and an unknown feeds the probe.
|
|
46
|
+
|
|
47
|
+
### Real problem
|
|
48
|
+
|
|
49
|
+
These two run on every proposal, and alone on a two-way local one.
|
|
50
|
+
|
|
51
|
+
- What does it solve, and who hits it? A proposal with no named user or measured failure is a guess
|
|
52
|
+
- Which goal does it serve, and does it cross a non-goal?
|
|
53
|
+
|
|
54
|
+
### Cause
|
|
55
|
+
|
|
56
|
+
These test the cause before the fix, so a fix for someone else's fault never ships as ours.
|
|
57
|
+
|
|
58
|
+
- Is the cause ours? Name the evidence that separates our fault from an upstream one, such as failures bunched by day or other repositories hit at once
|
|
59
|
+
- What is the strongest rival explanation, and what would prove the proposal wrong?
|
|
60
|
+
- Where did the numbers come from? A figure the proposal predicts rather than measured is a guess until read
|
|
61
|
+
|
|
62
|
+
### Worth it
|
|
63
|
+
|
|
64
|
+
These weigh the fix against doing nothing, and the last one asks the cautious direction.
|
|
65
|
+
|
|
66
|
+
- What does doing nothing cost, being how often it hurts and what one occurrence costs, such as a rerun?
|
|
67
|
+
- Does the fix route around the cause, or retry into it?
|
|
68
|
+
- Has its mechanism worked once, anywhere this project can see?
|
|
69
|
+
- Is it too cautious? Name the work a gate, a hold, or a narrowed scope stalls, and whether the risk it guards is worth that cost
|
|
70
|
+
|
|
71
|
+
### Premortem
|
|
72
|
+
|
|
73
|
+
Treating the failure as already happened surfaces reasons a forward-looking question misses.
|
|
74
|
+
|
|
75
|
+
- Assume it shipped and failed. What is the likeliest story of how?
|
|
76
|
+
|
|
77
|
+
### Cheapest probe
|
|
78
|
+
|
|
79
|
+
An unknown found above becomes a check here rather than a guess carried into the build.
|
|
80
|
+
|
|
81
|
+
- What small, reversible check would settle the largest unknown before the build, and what would it cost?
|
|
82
|
+
|
|
83
|
+
### Stop rule
|
|
84
|
+
|
|
85
|
+
A chain of mitigations needs an end point, set before the first one fails.
|
|
86
|
+
|
|
87
|
+
- After which failed attempt does the work stop mitigating and measure the cause instead?
|
|
88
|
+
|
|
89
|
+
## Step 4: route what evidence cannot answer
|
|
90
|
+
|
|
91
|
+
Settle every question the tree or the record can answer yourself. A question whose answer turns on what the operator wants, such as how much a rerun costs them, goes to them.
|
|
92
|
+
|
|
93
|
+
- Put every such question as one batch through the structured question surface, the way `decision-escalate` shapes a batch
|
|
94
|
+
- Hold the verdict until the batch is answered when an answer could move it, and give it now when none could
|
|
95
|
+
|
|
96
|
+
## Step 5: give one verdict
|
|
97
|
+
|
|
98
|
+
Pick one of four, and name the questions that decided it.
|
|
99
|
+
|
|
100
|
+
- **Go**: the problem is real, the cause is shown, and the fix is worth its cost. Build it as proposed
|
|
101
|
+
- **Probe first**: an unknown could flip the verdict, and a cheap reversible check settles it. Name the check
|
|
102
|
+
- **Absorb**: the cost of doing nothing is smaller than the fix, so live with the problem and record why
|
|
103
|
+
- **Stop**: the problem is not shown, the cause is not ours, or the proposal crosses a non-goal
|
|
104
|
+
|
|
105
|
+
On a two-way local change, go rests on the two real-problem answers alone, since a revert undoes a wrong go. Never give two verdicts or a verdict with a condition attached. A condition is a probe, so the verdict is probe first.
|
|
106
|
+
|
|
107
|
+
## Output
|
|
108
|
+
|
|
109
|
+
```plaintext
|
|
110
|
+
Proposal: <path, issue, or "read from the conversation">
|
|
111
|
+
Rating: <two-way|one-way>, <local|shipped>, because <reason>
|
|
112
|
+
Author: <independent read|written by this session, so the weak form>
|
|
113
|
+
|
|
114
|
+
<group>
|
|
115
|
+
- <question>: <answer>, per <evidence>
|
|
116
|
+
|
|
117
|
+
Verdict: <go|probe first|absorb|stop>, decided by <the questions that settled it>
|
|
118
|
+
<Probe: the check and its cost, on probe first alone>
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## What this delegates
|
|
122
|
+
|
|
123
|
+
- Batching questions only the operator can answer: `decision-escalate`
|
|
124
|
+
- Investigating a failure already in hand: `systematic-debugging`
|
|
125
|
+
- Judging a finished change: `review-pr`
|
|
126
|
+
- Writing the plan the verdict lets through: `plan-feature`
|