yam-flow 0.1.5 → 0.1.7

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.
@@ -66,6 +66,7 @@ Use these when the task depends on visual truth, reference matching, or design q
66
66
  3. Reference vs Implementation Matrix.
67
67
  4. Design Quality Review.
68
68
  5. Review Continuity and Comparison Report.
69
+ 6. Design Completion Gate.
69
70
 
70
71
  Default bound:
71
72
 
@@ -146,6 +147,27 @@ Review dimensions:
146
147
  For each relevant dimension, record `pass`, `needs-polish`, or `fails`.
147
148
  Keep actionable findings in P0-P3 order. Prefer fixing P0/P1 and cheap local P2 issues before broad polish.
148
149
 
150
+ ### Design Completion Gate
151
+
152
+ Use before claiming a Ueye implementation or serious review is done. This is the design-side completion check, not a separate route.
153
+
154
+ Record:
155
+
156
+ - `completion_claim`: draft, needs-polish, or done.
157
+ - `mode`: fast or strict.
158
+ - `design_score`, when score-based completion is useful.
159
+ - P0 and P1 open findings.
160
+ - Whether direction, reference read proof, implementation evidence, comparison, design quality, CTA affordance, state coverage, mobile/responsive behavior, and contrast/accessibility visuals were checked.
161
+ - blockers, warnings, next action, and truth status.
162
+
163
+ Gate behavior:
164
+
165
+ - Draft and needs-polish can stay fast.
166
+ - `done` automatically behaves as strict.
167
+ - P0 or blocked reason should return blocked.
168
+ - Missing required checks for a done claim should cap truth at partial.
169
+ - Only claim done when the gate says `ready_to_claim_done: true`.
170
+
149
171
  ### Review Continuity and Comparison Report
150
172
 
151
173
  Use when a screen has more than one visual pass, a reference needs follow-up, or a previous Ueye report should stay connected to the next one.
@@ -199,9 +221,10 @@ Keep this metadata descriptive. It should support honest visual claims, not forc
199
221
  6. Screenshot/browser recheck when feasible.
200
222
  7. Reference vs Implementation Matrix when reference fidelity matters.
201
223
  8. Design Quality Review.
202
- 9. Review Continuity and Comparison Report when the work spans multiple passes.
203
- 10. P0/P1 closeout.
204
- 11. Truth status.
224
+ 9. Design Completion Gate before any done claim.
225
+ 10. Review Continuity and Comparison Report when the work spans multiple passes.
226
+ 11. P0/P1 closeout.
227
+ 12. Truth status.
205
228
 
206
229
  ## Truth Caps
207
230
 
@@ -210,3 +233,4 @@ Keep this metadata descriptive. It should support honest visual claims, not forc
210
233
  - Blocked: requested visual claim cannot be inspected.
211
234
  - Assumed: implementation follows code patterns but visual result was not observed.
212
235
  - Reference-only or generated-only evidence cannot upgrade a result to full visual verification.
236
+ - A done claim without a passing design completion gate cannot upgrade beyond partial or blocked.
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: scout
3
- description: Lightweight investigation and judgment route. Use when the user invokes $scout or asks to find options, references, docs, tools, product direction, or third-party perspective before implementation.
3
+ description: Broad investigation and judgment route. Use when the user invokes $scout or asks to find options, references, docs, tools, product direction, security implications, or third-party perspective before implementation.
4
4
  ---
5
5
 
6
6
  # yam Scout
@@ -15,21 +15,27 @@ Use for:
15
15
  - Third-party judgment before committing to a direction.
16
16
  - Objective and subjective evaluation together.
17
17
  - Macro, realistic, and future-facing judgment.
18
+ - Broad reference scans when the user needs wider perspective.
19
+ - Security-centered direction checks before implementation.
20
+ - Finding patterns worth reworking into yam style.
18
21
 
19
22
  ## Principles
20
23
 
21
- - Scout, do not sprawl.
24
+ - Scout broadly enough to see the field, then compress the judgment.
22
25
  - Token economy is part of quality.
23
26
  - Reuse `yam.project.md` before broad context reading when present.
24
27
  - Prefer official and primary sources.
28
+ - Keep source boundaries clear: cite what was read, separate fact from inference, and do not blur reference material into yam claims.
25
29
  - Use current docs proof only when SDK/API/cloud-service freshness matters.
26
- - Keep the question narrow.
30
+ - Keep the decision clear, but do not make the field of view artificially narrow when the user asks for a broad scan.
27
31
  - Do not change code unless the user asks.
28
32
  - Return a practical recommendation.
29
33
  - Separate fact, inference, opinion, and recommendation.
30
34
  - Treat "objective" as evidence plus constraints, not certainty theater.
31
35
  - Treat "subjective" as named taste, product instinct, and likely user perception.
32
- - Keep source count bounded by default; use `$deep` only when the user asks for heavy verification.
36
+ - Security is the first lens: call out auth, payment, DB, secrets, permission, deployment, supply-chain, and public-release risks early.
37
+ - Source count should match the decision: 3-7 high-signal sources for focused scouting, more when the user explicitly asks for wide research.
38
+ - Use `$deep` when the user asks for heavy verification or when false confidence would be costly.
33
39
 
34
40
  ## Workflow
35
41
 
@@ -41,11 +47,12 @@ Use for:
41
47
  - product/technical direction memo
42
48
  - risk discovery
43
49
  3. Read `yam.project.md` first when project direction matters.
44
- 4. Gather 3-7 high-signal sources by default.
50
+ 4. Gather enough high-signal sources to support the decision; keep source quality higher than source volume.
45
51
  5. Compare options by fit, risk, cost, implementation effort, and durability.
46
- 6. Give both objective and subjective judgment when useful.
47
- 7. Recommend a direction.
48
- 8. State uncertainty and what would change the recommendation.
52
+ 6. Identify security and trust implications before convenience or aesthetics.
53
+ 7. Give both objective and subjective judgment when useful.
54
+ 8. Recommend a direction and which ideas are worth reworking into yam style.
55
+ 9. State uncertainty and what would change the recommendation.
49
56
 
50
57
  ## Output
51
58
 
@@ -57,9 +64,12 @@ Use concise sections:
57
64
  - Macro / realistic / future view when the decision benefits from it.
58
65
  - Alternatives.
59
66
  - Risks.
67
+ - Security lens.
68
+ - Ideas to rework into yam style.
60
69
  - Sources or local evidence.
70
+ - Remaining tasks or useful next improvements.
61
71
 
62
- Use `references/token-economy.md`; default to 3-7 high-signal sources.
72
+ Use `references/token-economy.md`; default to 3-7 high-signal sources unless the user asks for a broad research scan.
63
73
  Use `references/current-docs.md` for current SDK/API/cloud-service questions.
64
74
  Use `references/context-reuse.md`; do not rescout known decisions unless they may be stale.
65
75
  Use `references/markdown-management.md` before creating or updating project packs.
@@ -41,6 +41,9 @@ Do not use for:
41
41
  - Record surface context when it matters: provider context, provider badge, execution surface, app surface, browser surface, control mode, preserved URL/state, and evidence id.
42
42
  - Generated media can guide direction, but it cannot verify the implemented screen without implementation screenshot evidence.
43
43
  - Prefer the in-app browser for interactive visual checks. Do not switch to a profile-dependent browser unless the user explicitly asks or the task requires existing cookies, sessions, extensions, or profile state.
44
+ - Ueye owns the design completion gate. Do not rely on a separate code-risk route to catch sloppy visual completion.
45
+ - Draft or needs-polish work may stay fast; a `done` claim requires recorded design gate evidence.
46
+ - Do not claim a Ueye result is done when implementation evidence, design quality, P0/P1 status, state coverage, mobile/responsive behavior, contrast/accessibility visuals, CTA affordance, or reference-read/comparison evidence is missing where relevant.
44
47
 
45
48
  ## Workflow
46
49
 
@@ -78,8 +81,17 @@ Do not use for:
78
81
  - accessibility
79
82
  - brand or mood fit
80
83
  - mark each relevant dimension as pass, needs-polish, or fails.
81
- 11. Produce a P0-P3 visual issue ledger and fix path.
82
- 12. Recheck changed/high-risk screens after fixes when feasible.
84
+ 11. Run the Design Completion Gate before any "done" claim:
85
+ - direction locked
86
+ - reference read proof exists when reference-led
87
+ - implementation screenshot or source-screen evidence exists
88
+ - reference comparison is recorded when reference-led
89
+ - design quality is pass
90
+ - P0 is empty
91
+ - P1 is fixed or explicitly deferred
92
+ - CTA, states, mobile/responsive behavior, and contrast/accessibility visuals were checked
93
+ 12. Produce a P0-P3 visual issue ledger and fix path.
94
+ 13. Recheck changed/high-risk screens after fixes when feasible.
83
95
 
84
96
  ## Required Ueye Artifacts
85
97
 
@@ -106,7 +118,11 @@ Use these artifacts for reference-led implementation or serious visual review. K
106
118
  - use pass, needs-polish, or fails for each relevant design dimension.
107
119
  7. Review Continuity and Comparison Report, when this is a follow-up review:
108
120
  - record previous source/report, current source/report, comparison delta, resolved findings, new findings, still-open findings, truth status, and next action.
109
- 8. Media Generation Proof, when generated images are part of the task:
121
+ 8. Design Completion Gate, when implementation or review is claimed done:
122
+ - record completion claim, design score when used, P0/P1 status, gate checks, blockers, warnings, next action, and truth status.
123
+ - use `yam ueye report --completion-claim done --design-quality pass --direction-locked --states-checked --mobile-checked --contrast-checked --cta-checked --json` when a compact proof-ready gate is needed.
124
+ - if the gate is partial or blocked, report the Ueye result as partial or blocked instead of complete.
125
+ 9. Media Generation Proof, when generated images are part of the task:
110
126
  - record whether generation was requested, attempted, blocked, or produced an output.
111
127
  - use `yam media proof --requested --attempted --output path.png --wait-loop --json` when a generated image materially affects the design direction.
112
128
  - never use generated media proof as a substitute for implemented screen evidence.
@@ -120,6 +136,7 @@ Use these artifacts for reference-led implementation or serious visual review. K
120
136
  - Inspect 1-3 primary images by default; expand only for P0/P1 risk, responsive breakage, or user-requested deep visual QA.
121
137
  - Keep source-screen inventory to the 5 most important rows by default.
122
138
  - Screenshot unavailable: cap the result at `partial` or `blocked`.
139
+ - Completion gate missing for a `done` claim: cap the result at `partial` or `blocked`.
123
140
  - Text-only review: cap the result at `partial`.
124
141
  - Mock or invented screenshots: cap the result at `partial` and mark the source.
125
142
  - Browser unavailable but source files reviewed: report implementation verification separately from visual verification.