opencode-skills-collection 4.1.18 → 4.1.20

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.
Files changed (79) hide show
  1. package/bundled-skills/.antigravity-install-manifest.json +20 -1
  2. package/bundled-skills/ai-headshot-studio/SKILL.md +107 -99
  3. package/bundled-skills/ai-image-generation-studio/SKILL.md +108 -93
  4. package/bundled-skills/ai-logo-maker/SKILL.md +108 -93
  5. package/bundled-skills/ai-multilingual-dubbing/SKILL.md +108 -93
  6. package/bundled-skills/ai-photo-restyler/SKILL.md +108 -93
  7. package/bundled-skills/ai-podcast-voiceover/SKILL.md +108 -93
  8. package/bundled-skills/aident-loadout/SKILL.md +88 -0
  9. package/bundled-skills/antigravity-maintainer-batch-release/SKILL.md +27 -254
  10. package/bundled-skills/antigravity-maintainer-batch-release/agents/openai.yaml +1 -1
  11. package/bundled-skills/antigravity-maintainer-batch-release/references/component-validation.md +18 -0
  12. package/bundled-skills/antigravity-maintainer-batch-release/references/core-preview.md +20 -0
  13. package/bundled-skills/antigravity-maintainer-batch-release/references/maintenance-contract.md +83 -0
  14. package/bundled-skills/antigravity-maintainer-batch-release/references/maintenance-cycle.md +149 -0
  15. package/bundled-skills/antigravity-maintainer-batch-release/references/public-surfaces.md +22 -0
  16. package/bundled-skills/antigravity-maintainer-batch-release/references/skillspector.md +40 -0
  17. package/bundled-skills/apify-facebook-ads-library-scraper/SKILL.md +197 -0
  18. package/bundled-skills/apify-facebook-ads-library-scraper/references/gotchas.md +45 -0
  19. package/bundled-skills/apify-linkedin-jobs-scraper/SKILL.md +181 -0
  20. package/bundled-skills/apify-linkedin-jobs-scraper/references/gotchas.md +57 -0
  21. package/bundled-skills/apify-tiktok-scraper/SKILL.md +199 -0
  22. package/bundled-skills/apify-tiktok-scraper/references/gotchas.md +45 -0
  23. package/bundled-skills/arcmira-find-quotes/SKILL.md +5 -0
  24. package/bundled-skills/beatra/SKILL.md +109 -90
  25. package/bundled-skills/beatra-ai-video-studio/SKILL.md +110 -90
  26. package/bundled-skills/curlshot/SKILL.md +139 -0
  27. package/bundled-skills/datacircle/SKILL.md +159 -98
  28. package/bundled-skills/deed-page/SKILL.md +161 -0
  29. package/bundled-skills/design-token-contrast/SKILL.md +128 -0
  30. package/bundled-skills/design-token-contrast/references/contraste-checker.md +330 -0
  31. package/bundled-skills/ecommerce-listing-image-set/SKILL.md +109 -90
  32. package/bundled-skills/goal-instruction-writer/LICENSE +21 -0
  33. package/bundled-skills/goal-instruction-writer/SKILL.md +275 -0
  34. package/bundled-skills/goal-instruction-writer/references/contribution-walkthrough.md +9 -0
  35. package/bundled-skills/goal-instruction-writer/references/drift-control.md +160 -0
  36. package/bundled-skills/goal-instruction-writer/references/examples.md +220 -0
  37. package/bundled-skills/goal-instruction-writer/references/goal-contract.md +169 -0
  38. package/bundled-skills/goal-instruction-writer/references/loop-preview.md +113 -0
  39. package/bundled-skills/keenable-search-mcp/SKILL.md +176 -0
  40. package/bundled-skills/krexa/SKILL.md +221 -0
  41. package/bundled-skills/krexa/references/limits.md +42 -0
  42. package/bundled-skills/krexa/references/setup.md +60 -0
  43. package/bundled-skills/krexa/references/tools.md +59 -0
  44. package/bundled-skills/llm-cost-optimization/SKILL.md +1 -1
  45. package/bundled-skills/llmops-platform-engineering/SKILL.md +1 -1
  46. package/bundled-skills/multi-tenant-llm-hosting/SKILL.md +1 -1
  47. package/bundled-skills/music-generation-studio/SKILL.md +109 -90
  48. package/bundled-skills/outreachgenie-list-audit/LICENSE +21 -0
  49. package/bundled-skills/outreachgenie-list-audit/SKILL.md +60 -0
  50. package/bundled-skills/outreachgenie-list-audit/assets/fictional-snapshot.json +256 -0
  51. package/bundled-skills/outreachgenie-list-audit/references/capture.md +53 -0
  52. package/bundled-skills/outreachgenie-list-audit/references/checks.md +35 -0
  53. package/bundled-skills/outreachgenie-list-audit/references/setup.md +25 -0
  54. package/bundled-skills/outreachgenie-list-audit/scripts/audit.py +766 -0
  55. package/bundled-skills/outreachgenie-list-audit/scripts/test_audit.py +360 -0
  56. package/bundled-skills/pangolinfo-amazon-data-research/SKILL.md +170 -0
  57. package/bundled-skills/poster-design-studio/SKILL.md +109 -90
  58. package/bundled-skills/ppl-personal-crm/SKILL.md +118 -0
  59. package/bundled-skills/product-photo-studio/SKILL.md +109 -90
  60. package/bundled-skills/project-memory-log/LICENSE +21 -0
  61. package/bundled-skills/project-memory-log/SKILL.md +110 -0
  62. package/bundled-skills/project-memory-log/references/example-document-catalog.md +22 -0
  63. package/bundled-skills/project-memory-log/references/example-notes.md +16 -0
  64. package/bundled-skills/project-memory-log/references/example-operation-log.md +46 -0
  65. package/bundled-skills/project-memory-log/references/record-formats.md +77 -0
  66. package/bundled-skills/solidping/SKILL.md +87 -0
  67. package/bundled-skills/story-bible-continuity/SKILL.md +149 -0
  68. package/bundled-skills/story-bible-continuity/references/sbc-checker.md +367 -0
  69. package/bundled-skills/story-bible-continuity/references/story-bible-schema.md +91 -0
  70. package/bundled-skills/suno-lyrics-to-song/SKILL.md +109 -90
  71. package/bundled-skills/taasky/SKILL.md +376 -0
  72. package/bundled-skills/talking-avatar-video/SKILL.md +109 -90
  73. package/bundled-skills/uiverify-triage-visual-changes/SKILL.md +304 -0
  74. package/bundled-skills/unpaid-intern/SKILL.md +159 -0
  75. package/bundled-skills/viral-video-teardown-remake/SKILL.md +109 -90
  76. package/bundled-skills/voice-cloning-studio/SKILL.md +109 -90
  77. package/bundled-skills/voiceover-narration-studio/SKILL.md +109 -90
  78. package/package.json +1 -1
  79. package/skills_index.json +654 -24
@@ -0,0 +1,160 @@
1
+ # Drift Control Reference
2
+
3
+ Use this reference for Goals that run for more than a few iterations, cross
4
+ phases, touch several artifacts, or invite exploratory side quests. Drift is a
5
+ change in direction that is not justified by the Goal Anchor, even when the
6
+ new work is technically useful.
7
+
8
+ ## Freeze a Goal Anchor
9
+
10
+ Write this short block before the first work unit and carry it through every
11
+ checkpoint:
12
+
13
+ ```text
14
+ Goal Anchor: <one sentence describing the user/system outcome>
15
+ Success criteria: C1 <...>; C2 <...>; C3 <...>
16
+ Frozen scope: <invariants, protected behavior, and forbidden side effects>
17
+ Allowed authority: <tools, files, systems, and approvals available>
18
+ Current phase: <phase or milestone>
19
+ ```
20
+
21
+ The Anchor is an invariant, not a plan. Plans may change when evidence changes.
22
+ The outcome, acceptance criteria, frozen scope, or authority may change only
23
+ through an explicit owner decision, a durable scope-change record, or a new Goal
24
+ version. Never rewrite them to justify work that already happened.
25
+
26
+ ## Use an iteration alignment record
27
+
28
+ Before acting, write:
29
+
30
+ ```text
31
+ Iteration: <number>
32
+ Target criterion: <C1/C2/...>
33
+ Expected delta: <observable evidence that should change>
34
+ Scope reason: <why this is inside the frozen boundary now>
35
+ ```
36
+
37
+ After verifying, append:
38
+
39
+ ```text
40
+ Actual evidence: <test, diff, artifact, source, or decision>
41
+ Alignment: ON_TARGET | SIDE_QUEST | DRIFTED
42
+ Decision: continue | defer | replan | pause
43
+ Next cursor: <single next work unit or unblock>
44
+ ```
45
+
46
+ The three alignment labels have different behavior:
47
+
48
+ - **ON_TARGET:** the named criterion moved or new relevant evidence supports
49
+ a justified next step. Continue.
50
+ - **SIDE_QUEST:** the work may be useful but is not required by this Goal.
51
+ Record it in a deferred list and return to the next unmet criterion.
52
+ - **DRIFTED:** the work changed the Goal or scope without authorization, the
53
+ next action cannot be justified from the Anchor, or the no-progress threshold
54
+ is reached. Stop and realign.
55
+
56
+ ## Detect drift early
57
+
58
+ Treat any of these as a drift signal:
59
+
60
+ - The agent cannot name which criterion the current action advances.
61
+ - The expected evidence is replaced by activity, volume, or elapsed time.
62
+ - A new issue becomes the main work without a recorded link to the outcome.
63
+ - Allowed files, systems, sources, or side effects expand silently.
64
+ - The baseline or acceptance criteria are rewritten to fit completed work.
65
+ - Two materially equivalent actionable attempts produce neither acceptance
66
+ progress nor new relevant evidence.
67
+ - The plan keeps generating “one more” improvement after all criteria are
68
+ already verified.
69
+
70
+ The default no-progress threshold is two materially equivalent actionable
71
+ attempts; use a smaller threshold for high-risk or expensive work and a larger
72
+ one only when the task's evidence is naturally sparse.
73
+
74
+ ## Scheduled external waits
75
+
76
+ When an external response is pending, record the unmet criterion, dependency,
77
+ last observation, next check time (with timezone) or relevant notification, and
78
+ deadline or unblock condition in the current cursor.
79
+
80
+ Evaluate host limits and deadlines before the next-check trigger; an expired
81
+ limit takes precedence even when the next lookup is not yet due.
82
+
83
+ - Before the check trigger, do not issue another lookup or ping. Continue an
84
+ independently actionable criterion; if none remains, yield with the wait
85
+ checkpoint preserved. Waiting itself does not consume an actionable work
86
+ unit or increment the no-progress counter. It is not acceptance progress.
87
+ - On the agreed time or relevant notification, check the dependency once.
88
+ Reuse unchanged evidence and record a new justified check time if the
89
+ dependency remains pending within its window. A due observation of "still
90
+ pending" is neither a failed actionable attempt nor acceptance progress.
91
+ A notification warrants a check, not automatic acceptance of the response.
92
+ - Stop premature repeated polling and realign its schedule. Every actual tool
93
+ call, failed attempt, and elapsed interval remains subject to host budgets;
94
+ the waiting exception does not reset or extend those limits.
95
+ - If the feedback deadline arrives before the required response, report
96
+ `GOAL TIMEBOXED: awaiting first external feedback` with the open criterion
97
+ and resume condition. If another budget expires first, honor that limit.
98
+ Without a supported resume trigger, preserve the named dependency and apply
99
+ the host's blocked/yield rules instead of inventing more work.
100
+
101
+ A wait checkpoint does not schedule an automatic wake-up or authorize a new
102
+ message. Host status rules still apply; an owner pause remains distinct.
103
+
104
+ ## Run phase gates
105
+
106
+ Run a phase gate every 3–5 iterations by default, at each milestone, and before
107
+ an irreversible or high-cost action. A phase gate should:
108
+
109
+ 1. Re-read the Goal Anchor and compare it with the current state.
110
+ 2. Mark each criterion `open`, `verified`, or `blocked` with evidence.
111
+ 3. Review the diff or artifact list against Allowed and Frozen scope.
112
+ 4. Move side quests to the deferred list with a reason and revisit condition.
113
+ 5. Record one justified next action, its target criterion, and expected delta.
114
+
115
+ If all criteria are verified, finish as complete. If only a scheduled external
116
+ wait remains, preserve its checkpoint and yield; otherwise report the named
117
+ blocker under host rules. Do not invent work to keep the loop alive.
118
+
119
+ ## Recover from drift
120
+
121
+ When a drift trigger fires:
122
+
123
+ 1. Stop the current loop before taking another action.
124
+ 2. Write the alignment record and preserve the last durable cursor.
125
+ 3. Compare current changes with the baseline and classify them as aligned,
126
+ deferred side quest, or unauthorized scope change.
127
+ 4. Keep aligned evidence. Isolate or revert side-quest changes only when the
128
+ authority and repository safety rules allow it; never discard external work
129
+ silently.
130
+ 5. Re-plan one next action from the Anchor, or ask the owner for a scope or
131
+ objective decision.
132
+ 6. Resume only after the checkpoint records `ON_TARGET` and an expected delta.
133
+
134
+ Use `GOAL REALIGNMENT REQUIRED` as the default control stop. Report the
135
+ last aligned criterion, the drift trigger, preserved evidence, deferred work,
136
+ and the exact decision needed to resume.
137
+
138
+ ## Minimal prompt block
139
+
140
+ ```markdown
141
+ ## Goal anchor
142
+ - Outcome: <one immutable sentence>
143
+ - Criteria: <C1, C2, C3>
144
+ - Frozen scope: <invariants and forbidden side effects>
145
+ - Current phase: <phase or milestone>
146
+
147
+ ## Drift control
148
+ Before each iteration, name one target criterion, expected evidence delta, and
149
+ scope reason. After verification, label the result `ON_TARGET`, `SIDE_QUEST`, or
150
+ `DRIFTED`. Park side quests. Re-read the Anchor every 3–5 iterations, at phase
151
+ gates, and before irreversible work. If two equivalent actionable attempts add
152
+ neither acceptance progress nor new relevant evidence, or the Anchor/scope
153
+ changes without approval, stop and emit
154
+ `GOAL REALIGNMENT REQUIRED`; record the cursor and exact re-alignment
155
+ decision needed before resuming. For an agreed external wait, record the open
156
+ criterion, next check time/event, and deadline. Before that trigger, continue
157
+ independent work or yield. Waiting and a due observation of "still pending"
158
+ do not increment the failed-attempt counter or verify an acceptance criterion.
159
+ Actual calls and elapsed time remain subject to host budgets.
160
+ ```
@@ -0,0 +1,220 @@
1
+ # Goal Instruction Examples
2
+
3
+ These examples show the shape of the output. They are deliberately small so
4
+ they can be adapted to a real task.
5
+
6
+ ## Coding: fix a reproducible import failure
7
+
8
+ Weak request:
9
+
10
+ > Fix the importer and keep trying until it works.
11
+
12
+ Better Goal:
13
+
14
+ ```markdown
15
+ # Goal: Make the CSV importer accept quoted multiline fields
16
+
17
+ ## Objective
18
+ Update the importer so the fixture `fixtures/quoted_multiline.csv` loads into
19
+ the existing record model without truncation or row-count drift.
20
+
21
+ ## Baseline and scope
22
+ - Baseline: current `main` revision and the existing importer test suite.
23
+ - Allowed scope: importer code, its focused tests, and fixture data needed to
24
+ reproduce the failure.
25
+ - Frozen scope: public record fields, unrelated parsers, and dependencies.
26
+
27
+ ## Acceptance criteria
28
+ - [ ] The focused fixture test passes and preserves the expected row count.
29
+ - [ ] Existing importer tests pass.
30
+ - [ ] The diff explains the parsing boundary and contains no unrelated edits.
31
+
32
+ ## Verification strategy
33
+ During parser edits, run the focused fixture test. Once the parser is stable,
34
+ run the existing importer suite and review the diff. Record the checked parser,
35
+ fixtures, dependencies, and test environment; reuse passing results while those
36
+ inputs remain valid. A report-only edit needs a report check. A later parser
37
+ change requires the focused test and affected importer regressions again;
38
+ broaden if its impact is unclear. Apply the repository's command timeout to
39
+ expensive checks and leave any timed-out criterion open.
40
+
41
+ ## Execution loop
42
+ Inspect the failing fixture and parser state; make one smallest hypothesis-driven
43
+ change; run the focused test; record the result and diff; then choose the next
44
+ unmet criterion from the evidence.
45
+
46
+ ## Limits and no-op rule
47
+ Use at most four hypothesis iterations. Do not repeat a failed parser change
48
+ without new evidence; after two equivalent failures, report the blocker.
49
+
50
+ ## Termination
51
+ Emit `GOAL COMPLETE` only when all three criteria are verified. Emit
52
+ `GOAL BLOCKED: <reason>` if the fixture or required dependency is unavailable,
53
+ including the exact unblock needed. Emit `GOAL TIMEBOXED: <state>` after the
54
+ fourth iteration if the criteria remain open.
55
+
56
+ ## Reporting
57
+ Return the revision, commands and results, changed files, remaining gap, and
58
+ the terminal label. Distinguish newly run checks from reused evidence.
59
+ ```
60
+
61
+ ### SDK delivery: choose checks after a successful validation
62
+
63
+ Keep all required release checks, but let the actual change determine which
64
+ evidence must be refreshed:
65
+
66
+ | Later change | Next verification |
67
+ | --- | --- |
68
+ | Only the handoff report or receipt changes | Check that document; reuse runtime and artifact results whose inputs remain valid |
69
+ | A cancellation fix changes SDK behavior and the AAR | Run the affected regression checks, rebuild affected artifacts, and refresh consumer checks against the new AAR |
70
+ | A new API snapshot is added while the AAR is unchanged | Check the new snapshot; reuse existing compatibility and runtime results tied to the same AAR and inputs |
71
+
72
+ ## Research: compare two options
73
+
74
+ Weak request:
75
+
76
+ > Research these tools and tell me which one is best.
77
+
78
+ Better Goal:
79
+
80
+ ```markdown
81
+ # Goal: Recommend one analytics tool for the stated workload
82
+
83
+ ## Objective
84
+ Produce a cited comparison of Tool A and Tool B and recommend one option for a
85
+ team with <constraints>, with the trade-offs explicit enough for a decision.
86
+
87
+ ## Baseline and scope
88
+ - Baseline: official documentation and current pricing pages checked on the
89
+ research date.
90
+ - Allowed scope: public, first-party sources plus the user's stated workload.
91
+ - Frozen scope: do not infer private capabilities or promise an unverified
92
+ integration.
93
+
94
+ ## Acceptance criteria
95
+ - [ ] Each decision criterion has a source and a short evidence quote or
96
+ paraphrase.
97
+ - [ ] Material differences, costs, and constraints are compared in one table.
98
+ - [ ] The recommendation states when the other option would be better.
99
+
100
+ ## Execution loop
101
+ Inspect one criterion at a time; collect the strongest primary source for each
102
+ tool; record evidence and uncertainty; update the comparison; then select the
103
+ next criterion that could change the recommendation.
104
+
105
+ ## Limits and no-op rule
106
+ Cover the five agreed criteria and stop after one primary source per material
107
+ claim unless a conflict needs resolution. Do not keep searching after the
108
+ recommendation is stable and all criteria are sourced.
109
+
110
+ ## Termination
111
+ Emit `GOAL COMPLETE` when the table, citations, and conditional recommendation
112
+ are complete. Emit `GOAL BLOCKED: <missing constraint or source>` when a decision
113
+ depends on an owner answer or inaccessible evidence.
114
+
115
+ ## Reporting
116
+ Return the comparison, recommendation, uncertainty, sources, and terminal
117
+ label.
118
+ ```
119
+
120
+ ## Open source: publish a skill with an external maintainer gate
121
+
122
+ Weak request:
123
+
124
+ > Promote the skill everywhere and get it merged into a curated list.
125
+
126
+ Better Goal:
127
+
128
+ ```markdown
129
+ # Goal: Make the skill discoverable and leave the curated-list submission reviewable
130
+
131
+ ## Objective
132
+ Publish a validated skill package, create one reviewable distribution
133
+ submission, and record the exact external dependency if a maintainer must merge
134
+ it.
135
+
136
+ ## Goal anchor
137
+ - Outcome: the skill is installable from its source repository and its curated-list submission has a durable status.
138
+ - Criteria: C1 package validation; C2 one distribution submission; C3 feedback
139
+ and blocker record; C4 one non-author response.
140
+ - Frozen scope: no new social accounts, mass posting, repeated maintainer pings, or silent scope expansion.
141
+ - Current phase: launch and first feedback.
142
+
143
+ ## Baseline and scope
144
+ - Baseline: the current repository revision, release metadata, and existing
145
+ installation command.
146
+ - Allowed scope: the skill repository, one curated-list submission, and one
147
+ feedback thread.
148
+ - Authority: the agent may edit the repository and submit or update its own
149
+ contribution; only the upstream maintainer may merge the external PR.
150
+
151
+ ## Acceptance criteria
152
+ - [ ] The skill validator and installation smoke test pass.
153
+ - [ ] One public submission links to the repository and explains how to install it.
154
+ - [ ] The feedback thread records the use case, current status, and exact
155
+ unblock needed for any external gate.
156
+ - [ ] At least one non-author reply records a concrete use case, result, defect,
157
+ or improvement; an author-only comment does not satisfy this criterion.
158
+
159
+ ## Execution loop
160
+ Repeat one bounded work unit at a time:
161
+ 1. Inspect the durable cursor, then the repository, release, submission, and
162
+ feedback-thread status only when the relevant check is due.
163
+ 2. Select one open criterion, expected evidence, and scope reason.
164
+ 3. Make one focused documentation, packaging, or submission update.
165
+ 4. Verify the result with a validator, link, commit, or platform status.
166
+ 5. Classify it as `ON_TARGET`, `SIDE_QUEST`, or `DRIFTED`, then record the next
167
+ cursor.
168
+
169
+ ## Drift control
170
+ - Re-read the Anchor before each public post, version change, or new submission.
171
+ - Defer unrelated channels, feature ideas, and promotional experiments.
172
+ - If a maintainer gate is the only remaining work, preserve the named dependency
173
+ and its agreed resume trigger; otherwise report the exact blocker under host
174
+ rules. Do not repeatedly contact the maintainer.
175
+ - If the scope expands without approval, or two equivalent actionable attempts
176
+ add neither acceptance progress nor new relevant evidence, emit
177
+ `GOAL REALIGNMENT REQUIRED`.
178
+
179
+ ## Limits and no-op rule
180
+ - Use at most three actionable work units and one maintainer follow-up until
181
+ new review evidence arrives.
182
+ - Do not repeat a post or submission without a material change in evidence.
183
+ - While C4 is pending within its feedback window, record the last observation,
184
+ next agreed check time or reply notification, and deadline. Before that
185
+ trigger, skip further queries and pings; continue other open criteria or
186
+ yield with the checkpoint preserved. Verify any response before counting it.
187
+ - An agreed wait consumes neither an actionable work unit nor the no-progress
188
+ allowance; a due observation of "still pending" is not a failed attempt or
189
+ acceptance progress. Actual queries and elapsed time still count toward host
190
+ limits; stop premature repeated polling and realign its schedule.
191
+ - Define a feedback window before execution; if it closes without the required
192
+ non-author response, stop as `GOAL TIMEBOXED: awaiting first external feedback`.
193
+
194
+ ## Termination
195
+ - `GOAL COMPLETE` when the package, submission, status record, and feedback
196
+ threshold are verified.
197
+ - `GOAL BLOCKED: upstream maintainer review required` when only the external
198
+ merge remains, the submission is clean, and no supported resume trigger is
199
+ available; honor the host's blocked-status rules.
200
+ - `GOAL TIMEBOXED: awaiting first external feedback` when the feedback window
201
+ closes before the required non-author response arrives.
202
+ - `GOAL TIMEBOXED: <state>` when the launch window ends with the verified
203
+ progress and next safe action recorded.
204
+
205
+ ## Reporting
206
+ Return the release or revision, validation evidence, submission URL, current
207
+ external status, deferred side quests, remaining gap, and terminal label.
208
+ ```
209
+
210
+ ## Chinese output shape
211
+
212
+ When the user asks in Chinese, keep the same contract and translate the labels
213
+ or preserve exact terminal strings when a system already depends on them. For
214
+ example:
215
+
216
+ ```markdown
217
+ 目标:交付一个可验收的 <结果>
218
+ 循环:检查 → 选择一个最小工作单元 → 执行 → 验证 → 记录游标
219
+ 结束:`GOAL COMPLETE` / `GOAL BLOCKED: <原因>` / `GOAL TIMEBOXED: <状态>`
220
+ ```
@@ -0,0 +1,169 @@
1
+ # Goal Contract Reference
2
+
3
+ This reference defines the fields used by `goal-instruction-writer`. It is a
4
+ compact design contract rather than a generic project-management checklist.
5
+
6
+ ## Why the three layers matter
7
+
8
+ An agent can fail in three different ways:
9
+
10
+ 1. The **Goal** is vague, so activity is mistaken for progress.
11
+ 2. The **Loop** is unbounded, so the agent repeats work or drifts out of scope.
12
+ 3. The **Termination** rule is missing, so the agent cannot distinguish success
13
+ from a blocker, a pause, or an exhausted budget.
14
+
15
+ The three layers are evaluated together. A precise objective with no evidence
16
+ is not complete; a good loop with no limit can still run forever; a stop rule
17
+ with no progress signal can stop at the wrong time.
18
+
19
+ ## Field guide
20
+
21
+ | Field | Required question | Good evidence |
22
+ | --- | --- | --- |
23
+ | Objective | What observable end state should exist? | A file, behavior, decision, or verified fact |
24
+ | Goal anchor | What must remain true across iterations? | One-sentence outcome, criterion IDs, frozen scope, current phase |
25
+ | Loop preview | What will one iteration and each branch look like? | State transitions, first work unit, evidence, gates, terminal states |
26
+ | Baseline | What is authoritative now? | Revision, URL, dataset snapshot, or current finding |
27
+ | Allowed scope | What may change? | Named files, systems, sources, or decision boundary |
28
+ | Frozen scope | What must remain unchanged? | Explicitly protected behavior, data, or external state |
29
+ | Acceptance criteria | How will a reviewer know it is done? | Test result, diff, artifact, cited source, or checklist |
30
+ | Verification strategy | Which checks run during edits, at delivery, or after a change? | Focused checks, required broader gates, evidence validity, rerun reasons, cost bounds |
31
+ | Feedback evidence threshold | What counts as real feedback, and how much is required? | Entry point only, N non-author replies, named cohort, and a timebox |
32
+ | External wait (when applicable) | When may a pending dependency be checked again? | Open criterion, dependency, last observation, next check time/event, deadline or unblock |
33
+ | Work unit | What is one iteration small enough to verify? | One hypothesis, patch, experiment, or review slice |
34
+ | Progress signal | What changes after a useful iteration? | New evidence, reduced gap, changed artifact, or decision |
35
+ | Alignment check | How is each iteration tied back to the Goal? | Target criterion, expected delta, scope reason, alignment label |
36
+ | Drift trigger | When must the loop stop and realign? | No criterion moved, silent scope change, repeated no-progress iterations |
37
+ | Phase gate | When is the Anchor re-read? | Every 3–5 iterations, milestone, or before irreversible work |
38
+ | Decision log | What prevents rationale from being lost? | Decision, evidence, criterion, rejected side quest, scope impact |
39
+ | Limit | When must the loop yield? | Time, attempts, token/tool budget, or finite queue |
40
+ | No-op rule | What prevents repetition? | Change approach after failure; stop after repeated blocker |
41
+ | Terminal states | What are the legal endings? | Complete, blocked, paused, timeboxed/budgeted, stopped |
42
+ | Report | What survives the final response? | Status, evidence, remaining gap, cursor, next action |
43
+
44
+ ## Ready-to-paste skeleton
45
+
46
+ ```markdown
47
+ # Goal: <verb + observable outcome>
48
+
49
+ ## Objective
50
+ Produce <artifact/behavior/decision> so that <user or system value>.
51
+
52
+ ## Goal anchor
53
+ - Outcome: <one immutable sentence>
54
+ - Criteria: <C1, C2, C3>
55
+ - Frozen scope: <invariants and forbidden side effects>
56
+ - Current phase: <phase or milestone>
57
+
58
+ ## Baseline and scope
59
+ - Baseline: <authoritative revision, source, or current state>.
60
+ - Allowed scope: <files, systems, sources, or decisions that may change>.
61
+ - Frozen scope: <invariants and forbidden side effects>.
62
+ - Authority: <tools and approvals available; owner-only gates>.
63
+
64
+ ## Acceptance criteria
65
+ - [ ] <observable criterion with its evidence>
66
+ - [ ] <observable criterion with its evidence>
67
+ - [ ] <observable criterion with its evidence>
68
+
69
+ ## Feedback evidence (when applicable)
70
+ - Threshold: <entry point only | N non-author responses | named cohort>
71
+ - What counts: <concrete use case, result, defect, or decision>
72
+ - Window: <date, number of attempts, or timebox>
73
+
74
+ ## External wait (when applicable)
75
+ - Checkpoint: <open criterion, dependency, last observation>.
76
+ - Resume trigger: <next check time with timezone or relevant notification>;
77
+ deadline/unblock: <feedback deadline or named dependency resolution>.
78
+ - Check overall limits and deadlines first. Before the trigger, skip further
79
+ lookups or pings; continue independent work or yield with the checkpoint
80
+ preserved. On the trigger, verify the response.
81
+ - Waiting and a due observation of "still pending" are neither failed
82
+ actionable attempts nor acceptance progress. Actual tool calls and elapsed
83
+ time still count against the overall host limits.
84
+
85
+ ## Verification strategy
86
+ - Iteration checks: <smallest checks sufficient for the affected behavior>.
87
+ - Phase/delivery checks: <required broader checks and artifacts, with triggers>;
88
+ complete them once the relevant implementation is stable.
89
+ - Evidence reuse: record the checked source/artifact and relevant inputs,
90
+ dependencies, and environment; carry forward results while they remain valid.
91
+ Label reused and newly run checks separately. Documentation or receipt edits
92
+ do not invalidate unrelated runtime checks.
93
+ - Reruns: name the change or new evidence that invalidates a result; rerun
94
+ affected checks, including consumers of changed artifacts. Broaden when the
95
+ impact, a failure, uncertainty, or an explicit requirement warrants it.
96
+ - Cost bounds: <command timeouts or attempt caps for expensive checks>;
97
+ a timeout leaves the corresponding criterion open.
98
+
99
+ ## Execution loop
100
+ Repeat one bounded work unit at a time:
101
+ 1. Inspect <state and last cursor>; honor pending wait triggers before lookups.
102
+ 2. Select one unmet criterion, expected delta, and scope reason.
103
+ 3. Act within Allowed scope and Authority.
104
+ 4. Apply the verification strategy to the relevant criterion and capture evidence.
105
+ 5. Classify the iteration as `ON_TARGET`, `SIDE_QUEST`, or `DRIFTED`.
106
+ 6. Record the delta, remaining gap, decision, and next cursor.
107
+
108
+ ## Drift control
109
+ - Re-read the Goal anchor every 3–5 iterations, at phase gates, and before
110
+ irreversible or high-cost actions.
111
+ - Park side quests in a deferred list; do not expand the Goal silently.
112
+ - If two equivalent actionable attempts add neither acceptance progress nor
113
+ new relevant evidence, or the Anchor/scope changes without owner approval,
114
+ stop and emit `GOAL REALIGNMENT REQUIRED`. An agreed wait does not increment
115
+ this counter; stop repeated premature polling and realign its schedule.
116
+ - Resume only after recording the re-aligned next action and its expected delta.
117
+
118
+ ## Limits and no-op rule
119
+ - Limit: <timebox, budget, attempt cap, or finite work-unit list>.
120
+ - Do not repeat an action without new information. After <N> materially
121
+ equivalent failures, change the hypothesis or terminate as blocked.
122
+
123
+ ## Termination
124
+ - `GOAL COMPLETE` when all acceptance criteria are verified and the deliverable
125
+ is available. Stop; further checking requires invalidated evidence or a
126
+ concrete unresolved concern about a criterion.
127
+ - `GOAL BLOCKED: <reason>` when the next meaningful action needs a named
128
+ dependency, owner decision, or unresolved failure; include the unblock needed.
129
+ - `GOAL PAUSED: <reason>` only after an explicit owner pause; preserve the
130
+ cursor.
131
+ - `GOAL REALIGNMENT REQUIRED` when a drift check fails; preserve the checkpoint
132
+ and resume only after recording a justified next action within the Goal anchor.
133
+ - `GOAL TIMEBOXED: <state>` when the limit is reached; report progress and the
134
+ safest next action.
135
+ - `GOAL STOPPED: <reason>` when the owner cancels or authority would be
136
+ exceeded.
137
+
138
+ ## Reporting
139
+ After each iteration and at termination, report the terminal label (if any),
140
+ verified evidence, remaining gap, and next cursor or unblock.
141
+ ```
142
+
143
+ ## Quality checks
144
+
145
+ Before returning a Goal, check:
146
+
147
+ - For preview-first work, the loop was shown and confirmed before the final Goal
148
+ was generated.
149
+ - The objective describes an end state rather than a list of activities.
150
+ - The Goal anchor is short enough to re-read and is not silently mutable.
151
+ - Every acceptance criterion can be checked from named evidence.
152
+ - The verification strategy separates iteration checks from required phase or
153
+ delivery checks, defines evidence validity and rerun triggers, and bounds
154
+ expensive commands without weakening acceptance requirements.
155
+ - For feedback, adoption, pilot, launch, or validation work, the evidence
156
+ threshold and window are explicit; author-only activity is not counted unless
157
+ the Goal chooses it.
158
+ - Pending external waits have a next check trigger and deadline/unblock. The
159
+ loop skips early polling, can continue independent work or yield, and retains
160
+ overall budget limits without counting waiting as a failed attempt.
161
+ - Every iteration names one criterion, an expected delta, and a scope reason.
162
+ - The next iteration is selected from current state, not from a fixed script
163
+ that ignores results.
164
+ - The loop has a progress signal, a limit, a no-op rule, and a drift trigger.
165
+ - Phase gates and a decision log make long runs resumable and auditable.
166
+ - Complete, blocked, pause, and budget endings are distinguishable.
167
+ - The instruction does not grant new access or external side effects that the
168
+ user did not authorize.
169
+ - The final report leaves a durable cursor another agent could resume.
@@ -0,0 +1,113 @@
1
+ # Loop Preview Reference
2
+
3
+ Use this format when the user wants to inspect the execution loop before the
4
+ final Goal is written. The preview should be concrete enough to review, but it
5
+ is not permission to execute the work.
6
+
7
+ ## Preview contract
8
+
9
+ Show these elements in order:
10
+
11
+ 1. **Provisional outcome:** the current best one-sentence result, with
12
+ assumptions called out.
13
+ 2. **Starting state:** the baseline, known constraints, and first cursor.
14
+ 3. **Iteration flow:** what is inspected, selected, executed, verified, and
15
+ recorded in one cycle.
16
+ 4. **Branches:** what happens after success, a new failure, no progress, a side
17
+ quest, missing authority, a scheduled external wait, or a drift signal.
18
+ 5. **Progress evidence:** what must change for an iteration to count; which
19
+ checks run during edits or at delivery, when evidence can be reused, and
20
+ which changes trigger a rerun. Include bounds for expensive checks.
21
+ 6. **Drift gates:** when the Anchor is re-read and what triggers realignment.
22
+ 7. **Terminal states:** exact complete, blocked, paused, timeboxed, and stopped
23
+ conditions.
24
+ 8. **Decisions to confirm:** only the choices that could materially change the
25
+ loop, scope, evidence, or terminal rules. For feedback, adoption, pilot,
26
+ launch, or validation work, confirm the evidence threshold, what counts, and
27
+ the feedback window; for pending dependencies, include the next check
28
+ time/event, deadline/unblock, and independent work or yield branch.
29
+
30
+ End with a handoff such as: “确认这个循环后,我再生成最终 Goal 指令。” Do not
31
+ include a final executable Goal in a preview-only response and do not perform
32
+ external mutations.
33
+
34
+ ## Visual shape
35
+
36
+ ```mermaid
37
+ flowchart TD
38
+ A[Inspect baseline and cursor] --> W{Waiting before next check trigger?}
39
+ W -->|No| B[Choose one criterion and expected delta]
40
+ W -->|Yes| X{Independent work available?}
41
+ X -->|Yes| B
42
+ X -->|No| Y[Yield with wait checkpoint]
43
+ B --> C[Act within allowed scope]
44
+ C --> D[Verify evidence]
45
+ D --> E{Alignment check}
46
+ E -->|ON_TARGET| F[Record delta and next cursor]
47
+ F --> G{All criteria verified?}
48
+ G -->|No| H{Phase gate due?}
49
+ H -->|No| A
50
+ H -->|Yes| I[Re-read Anchor and review scope]
51
+ I --> A
52
+ G -->|Yes| J[GOAL COMPLETE]
53
+ E -->|SIDE_QUEST| K[Defer with revisit condition]
54
+ K --> A
55
+ E -->|DRIFTED| L[Pause and realign]
56
+ L --> M[GOAL REALIGNMENT REQUIRED]
57
+ D --> N{Blocked, budgeted, or owner-stopped?}
58
+ N -->|Blocked| O[GOAL BLOCKED]
59
+ N -->|Budget/time limit| P[GOAL TIMEBOXED]
60
+ N -->|Owner cancels| Q[GOAL STOPPED]
61
+ ```
62
+
63
+ Overall time, token, and tool limits apply on every branch. The wait checkpoint
64
+ records when the host or user may resume; it does not create a scheduler.
65
+
66
+ ## Preview table
67
+
68
+ | Point in the loop | Preview question | Required decision |
69
+ | --- | --- | --- |
70
+ | Start | What state and cursor are authoritative? | Baseline and first work unit |
71
+ | Select | Which criterion moves next? | Target criterion and expected delta |
72
+ | Act | What is inside the boundary? | Allowed scope and authority |
73
+ | Verify | What proves progress, and when must it be checked again? | Focused and phase/delivery checks, pass/fail rule, evidence reuse, rerun triggers, cost bounds |
74
+ | Branch | What happens if the result is unexpected? | Retry with a new hypothesis, defer, block, or realign |
75
+ | Gate | When is the Anchor re-read? | Cadence, milestone, and high-risk trigger |
76
+ | Feedback | How much evidence counts as real feedback? | Threshold, what counts, and feedback window |
77
+ | Wait | When can an external dependency be checked again? | Next check time/event, deadline/unblock, independent work or yield |
78
+ | End | What makes the work legally stop? | Complete, blocked, paused, timeboxed, stopped |
79
+
80
+ ## Example preview
81
+
82
+ ```markdown
83
+ ## Loop preview
84
+
85
+ ### Provisional outcome
86
+ Produce a tested importer patch that accepts the quoted multiline fixture.
87
+ Assumption: the current fixture and test command are authoritative.
88
+
89
+ ### One iteration
90
+ Inspect the failing parser path → choose one parsing hypothesis → make one
91
+ focused change → run the fixture test → record the diff and result.
92
+
93
+ ### Branches
94
+ - Test passes: mark C1 verified and select the next open criterion.
95
+ - Test fails with new evidence: revise the hypothesis and try one different
96
+ focused change.
97
+ - Same failure twice: stop as `GOAL BLOCKED` with the exact missing evidence.
98
+ - Useful unrelated cleanup: mark `SIDE_QUEST` and defer it.
99
+ - No criterion moves or scope expands: pause as
100
+ `GOAL REALIGNMENT REQUIRED`.
101
+
102
+ ### Gate and limits
103
+ Re-read the Anchor after three iterations and before changing dependencies.
104
+ Use at most four hypothesis iterations. Run the existing importer suite once
105
+ the parser is stable; after a further parser change, refresh affected regression
106
+ evidence. Report-only edits do not invalidate unrelated passing parser checks.
107
+ Use the repository's command timeout for expensive checks; report any unverified
108
+ criterion if it expires.
109
+
110
+ ### Confirm before drafting
111
+ Please confirm the retry threshold and whether dependency changes are allowed;
112
+ then the final Goal can be generated.
113
+ ```