@ikon85/agent-workflow-kit 0.10.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/.agents/skills/ask-matt/SKILL.md +139 -0
- package/.agents/skills/ask-matt/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/audit-skills/SKILL.md +145 -0
- package/.agents/skills/board-to-waves/SKILL.md +135 -0
- package/.agents/skills/code-review/SKILL.md +64 -0
- package/.agents/skills/codebase-design/DEEPENING.md +37 -0
- package/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +44 -0
- package/.agents/skills/codebase-design/SKILL.md +114 -0
- package/.agents/skills/codebase-design/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/codex-adapter-sync/SKILL.md +151 -0
- package/.agents/skills/decision-gate/SKILL.md +67 -0
- package/.agents/skills/diagnose/SKILL.md +136 -0
- package/.agents/skills/diagnose/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/diagnose/scripts/hitl-loop.template.sh +41 -0
- package/.agents/skills/domain-modeling/ADR-FORMAT.md +47 -0
- package/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +60 -0
- package/.agents/skills/domain-modeling/SKILL.md +76 -0
- package/.agents/skills/domain-modeling/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/git-worktree-recover/SKILL.md +176 -0
- package/.agents/skills/grill-me/SKILL.md +54 -0
- package/.agents/skills/grill-me/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- package/.agents/skills/grill-with-docs/CONTEXT-FORMAT.md +60 -0
- package/.agents/skills/grill-with-docs/SKILL.md +137 -0
- package/.agents/skills/grill-with-docs/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/implement/SKILL.md +15 -0
- package/.agents/skills/implement/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/improve-codebase-architecture/ADR-FORMAT.md +47 -0
- package/.agents/skills/improve-codebase-architecture/CONTEXT-FORMAT.md +60 -0
- package/.agents/skills/improve-codebase-architecture/DEEPENING.md +37 -0
- package/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
- package/.agents/skills/improve-codebase-architecture/INTERFACE-DESIGN.md +46 -0
- package/.agents/skills/improve-codebase-architecture/LANGUAGE.md +53 -0
- package/.agents/skills/improve-codebase-architecture/SKILL.md +88 -0
- package/.agents/skills/improve-codebase-architecture/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/kit-release/SKILL.md +56 -0
- package/.agents/skills/local-ci/SKILL.md +94 -0
- package/.agents/skills/orchestrate-wave/SKILL.md +261 -0
- package/.agents/skills/orchestrate-wave/references/builder-contract.md +67 -0
- package/.agents/skills/prototype/LOGIC.md +79 -0
- package/.agents/skills/prototype/SKILL.md +30 -0
- package/.agents/skills/prototype/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/prototype/UI.md +112 -0
- package/.agents/skills/research/SKILL.md +12 -0
- package/.agents/skills/research/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/resolving-merge-conflicts/SKILL.md +14 -0
- package/.agents/skills/resolving-merge-conflicts/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/retro/SKILL.md +209 -0
- package/.agents/skills/scale-check/SKILL.md +141 -0
- package/.agents/skills/security-audit/SKILL.md +67 -0
- package/.agents/skills/setup-workflow/SKILL.md +187 -0
- package/.agents/skills/setup-workflow/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/setup-workflow/board-sync.md +111 -0
- package/.agents/skills/setup-workflow/code-review.md +26 -0
- package/.agents/skills/setup-workflow/domain.md +51 -0
- package/.agents/skills/setup-workflow/issue-tracker-github.md +35 -0
- package/.agents/skills/setup-workflow/issue-tracker-gitlab.md +34 -0
- package/.agents/skills/setup-workflow/issue-tracker-local.md +30 -0
- package/.agents/skills/setup-workflow/orchestrate-wave-seed.md +44 -0
- package/.agents/skills/setup-workflow/spec-completeness-seed.md +44 -0
- package/.agents/skills/setup-workflow/spec-self-critique-seed.md +43 -0
- package/.agents/skills/setup-workflow/triage-labels.md +18 -0
- package/.agents/skills/setup-workflow/workflow-overview.md +33 -0
- package/.agents/skills/spec-self-critique/SKILL.md +152 -0
- package/.agents/skills/spec-self-critique/scenarios.md +82 -0
- package/.agents/skills/tdd/SKILL.md +120 -0
- package/.agents/skills/tdd/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/tdd/deep-modules.md +33 -0
- package/.agents/skills/tdd/interface-design.md +31 -0
- package/.agents/skills/tdd/mocking.md +59 -0
- package/.agents/skills/tdd/refactoring.md +10 -0
- package/.agents/skills/tdd/tests.md +61 -0
- package/.agents/skills/to-issues/SKILL.md +325 -0
- package/.agents/skills/to-issues/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/to-prd/PROGRAM-PRD-FORMAT.md +162 -0
- package/.agents/skills/to-prd/SKILL.md +180 -0
- package/.agents/skills/to-prd/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/to-waves/SKILL.md +260 -0
- package/.agents/skills/to-waves/SLICE-METADATA-FORMAT.md +74 -0
- package/.agents/skills/triage/AGENT-BRIEF.md +168 -0
- package/.agents/skills/triage/OUT-OF-SCOPE.md +101 -0
- package/.agents/skills/triage/SKILL.md +122 -0
- package/.agents/skills/triage/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/verify-spike/SKILL.md +39 -0
- package/.agents/skills/wayfinder/SKILL.md +127 -0
- package/.agents/skills/wayfinder/THIRD-PARTY-NOTICES.md +29 -0
- package/.agents/skills/wrapup/SKILL.md +71 -0
- package/.agents/skills/wrapup/SOURCES.txt +6 -0
- package/.agents/skills/zoom-out/SKILL.md +7 -0
- package/.agents/skills/zoom-out/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/hooks/_hook_utils.py +184 -0
- package/.claude/hooks/drift-guard.py +176 -0
- package/.claude/hooks/skill-drift-hint.py +122 -0
- package/.claude/hooks/sync-board-status.py +191 -0
- package/.claude/skills/ask-matt/SKILL.md +139 -0
- package/.claude/skills/ask-matt/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/audit-skills/SKILL.md +145 -0
- package/.claude/skills/board-to-waves/SKILL.md +148 -0
- package/.claude/skills/code-review/SKILL.md +64 -0
- package/.claude/skills/codebase-design/DEEPENING.md +37 -0
- package/.claude/skills/codebase-design/DESIGN-IT-TWICE.md +44 -0
- package/.claude/skills/codebase-design/SKILL.md +114 -0
- package/.claude/skills/codebase-design/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/codex-build/SKILL.md +126 -0
- package/.claude/skills/codex-build/THIRD-PARTY-NOTICES.md +35 -0
- package/.claude/skills/codex-review/SKILL.md +145 -0
- package/.claude/skills/codex-review/THIRD-PARTY-NOTICES.md +31 -0
- package/.claude/skills/decision-gate/SKILL.md +67 -0
- package/.claude/skills/diagnose/SKILL.md +136 -0
- package/.claude/skills/diagnose/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/diagnose/scripts/hitl-loop.template.sh +41 -0
- package/.claude/skills/domain-modeling/ADR-FORMAT.md +47 -0
- package/.claude/skills/domain-modeling/CONTEXT-FORMAT.md +60 -0
- package/.claude/skills/domain-modeling/SKILL.md +76 -0
- package/.claude/skills/domain-modeling/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/git-guardrails-claude-code/SKILL.md +96 -0
- package/.claude/skills/git-guardrails-claude-code/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/git-guardrails-claude-code/scripts/block-dangerous-git.sh +28 -0
- package/.claude/skills/git-worktree-recover/SKILL.md +182 -0
- package/.claude/skills/grill-me/SKILL.md +54 -0
- package/.claude/skills/grill-me/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/grill-me-codex/SKILL.md +158 -0
- package/.claude/skills/grill-me-codex/THIRD-PARTY-NOTICES.md +32 -0
- package/.claude/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- package/.claude/skills/grill-with-docs/CONTEXT-FORMAT.md +60 -0
- package/.claude/skills/grill-with-docs/SKILL.md +137 -0
- package/.claude/skills/grill-with-docs/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/grill-with-docs-codex/ADR-FORMAT.md +47 -0
- package/.claude/skills/grill-with-docs-codex/CONTEXT-FORMAT.md +60 -0
- package/.claude/skills/grill-with-docs-codex/SKILL.md +233 -0
- package/.claude/skills/grill-with-docs-codex/THIRD-PARTY-NOTICES.md +33 -0
- package/.claude/skills/implement/SKILL.md +15 -0
- package/.claude/skills/implement/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/improve-codebase-architecture/ADR-FORMAT.md +47 -0
- package/.claude/skills/improve-codebase-architecture/CONTEXT-FORMAT.md +60 -0
- package/.claude/skills/improve-codebase-architecture/DEEPENING.md +37 -0
- package/.claude/skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
- package/.claude/skills/improve-codebase-architecture/INTERFACE-DESIGN.md +46 -0
- package/.claude/skills/improve-codebase-architecture/LANGUAGE.md +53 -0
- package/.claude/skills/improve-codebase-architecture/SKILL.md +88 -0
- package/.claude/skills/improve-codebase-architecture/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/kit-release/SKILL.md +56 -0
- package/.claude/skills/local-ci/SKILL.md +94 -0
- package/.claude/skills/orchestrate-wave/SKILL.md +269 -0
- package/.claude/skills/orchestrate-wave/references/builder-contract.md +67 -0
- package/.claude/skills/prototype/LOGIC.md +79 -0
- package/.claude/skills/prototype/SKILL.md +30 -0
- package/.claude/skills/prototype/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/prototype/UI.md +112 -0
- package/.claude/skills/research/SKILL.md +12 -0
- package/.claude/skills/research/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/resolving-merge-conflicts/SKILL.md +14 -0
- package/.claude/skills/resolving-merge-conflicts/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/retro/SKILL.md +209 -0
- package/.claude/skills/scale-check/SKILL.md +141 -0
- package/.claude/skills/security-audit/SKILL.md +67 -0
- package/.claude/skills/setup-pre-commit/SKILL.md +104 -0
- package/.claude/skills/setup-pre-commit/scripts/pre-commit.template.sh +35 -0
- package/.claude/skills/setup-workflow/SKILL.md +187 -0
- package/.claude/skills/setup-workflow/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/setup-workflow/board-sync.md +111 -0
- package/.claude/skills/setup-workflow/code-review.md +26 -0
- package/.claude/skills/setup-workflow/domain.md +51 -0
- package/.claude/skills/setup-workflow/issue-tracker-github.md +35 -0
- package/.claude/skills/setup-workflow/issue-tracker-gitlab.md +34 -0
- package/.claude/skills/setup-workflow/issue-tracker-local.md +30 -0
- package/.claude/skills/setup-workflow/orchestrate-wave-seed.md +44 -0
- package/.claude/skills/setup-workflow/spec-completeness-seed.md +44 -0
- package/.claude/skills/setup-workflow/spec-self-critique-seed.md +43 -0
- package/.claude/skills/setup-workflow/triage-labels.md +18 -0
- package/.claude/skills/setup-workflow/workflow-overview.md +33 -0
- package/.claude/skills/skill-manifest.json +389 -0
- package/.claude/skills/spec-self-critique/SKILL.md +152 -0
- package/.claude/skills/spec-self-critique/scenarios.md +82 -0
- package/.claude/skills/tdd/SKILL.md +120 -0
- package/.claude/skills/tdd/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/tdd/deep-modules.md +33 -0
- package/.claude/skills/tdd/interface-design.md +31 -0
- package/.claude/skills/tdd/mocking.md +59 -0
- package/.claude/skills/tdd/refactoring.md +10 -0
- package/.claude/skills/tdd/tests.md +61 -0
- package/.claude/skills/to-issues/SKILL.md +325 -0
- package/.claude/skills/to-issues/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/to-prd/PROGRAM-PRD-FORMAT.md +162 -0
- package/.claude/skills/to-prd/SKILL.md +180 -0
- package/.claude/skills/to-prd/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/to-waves/SKILL.md +260 -0
- package/.claude/skills/to-waves/SLICE-METADATA-FORMAT.md +74 -0
- package/.claude/skills/triage/AGENT-BRIEF.md +168 -0
- package/.claude/skills/triage/OUT-OF-SCOPE.md +101 -0
- package/.claude/skills/triage/SKILL.md +122 -0
- package/.claude/skills/triage/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/verify-spike/SKILL.md +39 -0
- package/.claude/skills/wayfinder/SKILL.md +127 -0
- package/.claude/skills/wayfinder/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/wrapup/SKILL.md +81 -0
- package/.claude/skills/wrapup/SOURCES.txt +6 -0
- package/.claude/skills/write-a-skill/GLOSSARY.md +201 -0
- package/.claude/skills/write-a-skill/SKILL.md +88 -0
- package/.claude/skills/write-a-skill/THIRD-PARTY-NOTICES.md +29 -0
- package/.claude/skills/zoom-out/SKILL.md +7 -0
- package/.claude/skills/zoom-out/THIRD-PARTY-NOTICES.md +29 -0
- package/LICENSE +28 -0
- package/PROVENANCE.md +39 -0
- package/README.md +619 -0
- package/agent-workflow-kit.package.json +1939 -0
- package/docs/agents/board-sync.md +71 -0
- package/docs/agents/code-review.md +14 -0
- package/docs/agents/domain.md +7 -0
- package/docs/agents/issue-tracker.md +12 -0
- package/docs/agents/security-audit-runbook-template.md +205 -0
- package/docs/agents/skills/orchestrate-wave.md +13 -0
- package/docs/agents/skills/spec-self-critique.md +18 -0
- package/docs/agents/triage-labels.md +10 -0
- package/docs/agents/wave-anchor-template.md +88 -0
- package/docs/conventions/spec-completeness.md +23 -0
- package/docs/index.html +56 -0
- package/docs/methodology.html +488 -0
- package/docs/methodology.svg +93 -0
- package/docs/workflow.png +0 -0
- package/package.json +40 -0
- package/scripts/anchor_table.py +343 -0
- package/scripts/board-sync.py +1232 -0
- package/scripts/board_config.py +147 -0
- package/scripts/board_fields.py +192 -0
- package/scripts/build-kit.mjs +116 -0
- package/scripts/build-kit.test.mjs +59 -0
- package/scripts/check-kit-staleness.mjs +45 -0
- package/scripts/check-kit-staleness.test.mjs +19 -0
- package/scripts/execute-ready-check.py +516 -0
- package/scripts/issue_deps.py +79 -0
- package/scripts/kit-release.mjs +100 -0
- package/scripts/kit-release.test.mjs +67 -0
- package/scripts/lib/audit-refs.mjs +146 -0
- package/scripts/lib/scrub.mjs +113 -0
- package/scripts/lib/scrub.test.mjs +187 -0
- package/scripts/loc_offender_core.py +196 -0
- package/scripts/loc_offender_gate.py +182 -0
- package/scripts/node_kind.py +68 -0
- package/scripts/portability_profile_scan.py +53 -0
- package/scripts/pr-body-check.py +263 -0
- package/scripts/program_graph.py +125 -0
- package/scripts/program_graph_parse.py +275 -0
- package/scripts/program_graph_validate.py +256 -0
- package/scripts/program_sync.py +160 -0
- package/scripts/release-delta-guard.mjs +96 -0
- package/scripts/release-delta-guard.test.mjs +53 -0
- package/scripts/test_board_sync_create_idempotency.py +104 -0
- package/scripts/test_dist_kit_smoke.py +199 -0
- package/scripts/test_kit_docs_language_census.py +178 -0
- package/scripts/test_skill_code_review_seed.py +89 -0
- package/scripts/test_skill_frontmatter_lint.py +226 -0
- package/scripts/test_skill_gh_lint.py +124 -0
- package/scripts/test_skill_language_census.py +254 -0
- package/scripts/test_skill_portability_lint.py +773 -0
- package/scripts/test_skill_publish_audit.py +300 -0
- package/scripts/test_skill_selfcontainment_lint.py +255 -0
- package/scripts/test_skill_setup_workflow_seeds.py +200 -0
- package/scripts/test_skill_stale_name_lint.py +126 -0
- package/scripts/test_skill_surface_refs.py +300 -0
- package/scripts/test_skill_trailing_artifact_lint.py +71 -0
- package/scripts/wrapup-land.py +573 -0
- package/src/cli.mjs +70 -0
- package/src/commands/diff.mjs +6 -0
- package/src/commands/init.mjs +59 -0
- package/src/commands/uninstall.mjs +43 -0
- package/src/commands/update.mjs +95 -0
- package/src/lib/atomicWrite.mjs +49 -0
- package/src/lib/bundle.mjs +133 -0
- package/src/lib/hash.mjs +13 -0
- package/src/lib/manifest.mjs +58 -0
- package/src/lib/sentinel.mjs +20 -0
- package/src/lib/settings.mjs +23 -0
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Writing Agent Briefs
|
|
2
|
+
|
|
3
|
+
An agent brief is a structured comment posted on a GitHub issue when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original issue body and discussion are context — the agent brief is the contract.
|
|
4
|
+
|
|
5
|
+
## Principles
|
|
6
|
+
|
|
7
|
+
### Durability over precision
|
|
8
|
+
|
|
9
|
+
The issue may sit in `ready-for-agent` for days or weeks. The codebase will change in the meantime. Write the brief so it stays useful even as files are renamed, moved, or refactored.
|
|
10
|
+
|
|
11
|
+
- **Do** describe interfaces, types, and behavioral contracts
|
|
12
|
+
- **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
|
|
13
|
+
- **Don't** reference file paths — they go stale
|
|
14
|
+
- **Don't** reference line numbers
|
|
15
|
+
- **Don't** assume the current implementation structure will remain the same
|
|
16
|
+
|
|
17
|
+
### Behavioral, not procedural
|
|
18
|
+
|
|
19
|
+
Describe **what** the system should do, not **how** to implement it. The agent will explore the codebase fresh and make its own implementation decisions.
|
|
20
|
+
|
|
21
|
+
- **Good:** "The `SkillConfig` type should accept an optional `schedule` field of type `CronExpression`"
|
|
22
|
+
- **Bad:** "Open src/types/skill.ts and add a schedule field on line 42"
|
|
23
|
+
- **Good:** "When a user runs `/triage` with no arguments, they should see a summary of issues needing attention"
|
|
24
|
+
- **Bad:** "Add a switch statement in the main handler function"
|
|
25
|
+
|
|
26
|
+
### Complete acceptance criteria
|
|
27
|
+
|
|
28
|
+
The agent needs to know when it's done. Every agent brief must have concrete, testable acceptance criteria. Each criterion should be independently verifiable.
|
|
29
|
+
|
|
30
|
+
- **Good:** "Running `gh issue list --label needs-triage` returns issues that have been through initial classification"
|
|
31
|
+
- **Bad:** "Triage should work correctly"
|
|
32
|
+
|
|
33
|
+
### Explicit scope boundaries
|
|
34
|
+
|
|
35
|
+
State what is out of scope. This prevents the agent from gold-plating or making assumptions about adjacent features.
|
|
36
|
+
|
|
37
|
+
## Template
|
|
38
|
+
|
|
39
|
+
```markdown
|
|
40
|
+
## Agent Brief
|
|
41
|
+
|
|
42
|
+
**Category:** bug / enhancement
|
|
43
|
+
**Summary:** one-line description of what needs to happen
|
|
44
|
+
|
|
45
|
+
**Current behavior:**
|
|
46
|
+
Describe what happens now. For bugs, this is the broken behavior.
|
|
47
|
+
For enhancements, this is the status quo the feature builds on.
|
|
48
|
+
|
|
49
|
+
**Desired behavior:**
|
|
50
|
+
Describe what should happen after the agent's work is complete.
|
|
51
|
+
Be specific about edge cases and error conditions.
|
|
52
|
+
|
|
53
|
+
**Key interfaces:**
|
|
54
|
+
- `TypeName` — what needs to change and why
|
|
55
|
+
- `functionName()` return type — what it currently returns vs what it should return
|
|
56
|
+
- Config shape — any new configuration options needed
|
|
57
|
+
|
|
58
|
+
**Acceptance criteria:**
|
|
59
|
+
- [ ] Specific, testable criterion 1
|
|
60
|
+
- [ ] Specific, testable criterion 2
|
|
61
|
+
- [ ] Specific, testable criterion 3
|
|
62
|
+
|
|
63
|
+
**Out of scope:**
|
|
64
|
+
- Thing that should NOT be changed or addressed in this issue
|
|
65
|
+
- Adjacent feature that might seem related but is separate
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Examples
|
|
69
|
+
|
|
70
|
+
### Good agent brief (bug)
|
|
71
|
+
|
|
72
|
+
```markdown
|
|
73
|
+
## Agent Brief
|
|
74
|
+
|
|
75
|
+
**Category:** bug
|
|
76
|
+
**Summary:** Skill description truncation drops mid-word, producing broken output
|
|
77
|
+
|
|
78
|
+
**Current behavior:**
|
|
79
|
+
When a skill description exceeds 1024 characters, it is truncated at exactly
|
|
80
|
+
1024 characters regardless of word boundaries. This produces descriptions
|
|
81
|
+
that end mid-word (e.g. "Use when the user wants to confi").
|
|
82
|
+
|
|
83
|
+
**Desired behavior:**
|
|
84
|
+
Truncation should break at the last word boundary before 1024 characters
|
|
85
|
+
and append "..." to indicate truncation.
|
|
86
|
+
|
|
87
|
+
**Key interfaces:**
|
|
88
|
+
- The `SkillMetadata` type's `description` field — no type change needed,
|
|
89
|
+
but the validation/processing logic that populates it needs to respect
|
|
90
|
+
word boundaries
|
|
91
|
+
- Any function that reads SKILL.md frontmatter and extracts the description
|
|
92
|
+
|
|
93
|
+
**Acceptance criteria:**
|
|
94
|
+
- [ ] Descriptions under 1024 chars are unchanged
|
|
95
|
+
- [ ] Descriptions over 1024 chars are truncated at the last word boundary
|
|
96
|
+
before 1024 chars
|
|
97
|
+
- [ ] Truncated descriptions end with "..."
|
|
98
|
+
- [ ] The total length including "..." does not exceed 1024 chars
|
|
99
|
+
|
|
100
|
+
**Out of scope:**
|
|
101
|
+
- Changing the 1024 char limit itself
|
|
102
|
+
- Multi-line description support
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Good agent brief (enhancement)
|
|
106
|
+
|
|
107
|
+
```markdown
|
|
108
|
+
## Agent Brief
|
|
109
|
+
|
|
110
|
+
**Category:** enhancement
|
|
111
|
+
**Summary:** Add `.out-of-scope/` directory support for tracking rejected feature requests
|
|
112
|
+
|
|
113
|
+
**Current behavior:**
|
|
114
|
+
When a feature request is rejected, the issue is closed with a `wontfix` label
|
|
115
|
+
and a comment. There is no persistent record of the decision or reasoning.
|
|
116
|
+
Future similar requests require the maintainer to recall or search for the
|
|
117
|
+
prior discussion.
|
|
118
|
+
|
|
119
|
+
**Desired behavior:**
|
|
120
|
+
Rejected feature requests should be documented in `.out-of-scope/<concept>.md`
|
|
121
|
+
files that capture the decision, reasoning, and links to all issues that
|
|
122
|
+
requested the feature. When triaging new issues, these files should be
|
|
123
|
+
checked for matches.
|
|
124
|
+
|
|
125
|
+
**Key interfaces:**
|
|
126
|
+
- Markdown file format in `.out-of-scope/` — each file should have a
|
|
127
|
+
`# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
|
|
128
|
+
and a `**Prior requests:**` list with issue links
|
|
129
|
+
- The triage workflow should read all `.out-of-scope/*.md` files early
|
|
130
|
+
and match incoming issues against them by concept similarity
|
|
131
|
+
|
|
132
|
+
**Acceptance criteria:**
|
|
133
|
+
- [ ] Closing a feature as wontfix creates/updates a file in `.out-of-scope/`
|
|
134
|
+
- [ ] The file includes the decision, reasoning, and link to the closed issue
|
|
135
|
+
- [ ] If a matching `.out-of-scope/` file already exists, the new issue is
|
|
136
|
+
appended to its "Prior requests" list rather than creating a duplicate
|
|
137
|
+
- [ ] During triage, existing `.out-of-scope/` files are checked and surfaced
|
|
138
|
+
when a new issue matches a prior rejection
|
|
139
|
+
|
|
140
|
+
**Out of scope:**
|
|
141
|
+
- Automated matching (human confirms the match)
|
|
142
|
+
- Reopening previously rejected features
|
|
143
|
+
- Bug reports (only enhancement rejections go to `.out-of-scope/`)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Bad agent brief
|
|
147
|
+
|
|
148
|
+
```markdown
|
|
149
|
+
## Agent Brief
|
|
150
|
+
|
|
151
|
+
**Summary:** Fix the triage bug
|
|
152
|
+
|
|
153
|
+
**What to do:**
|
|
154
|
+
The triage thing is broken. Look at the main file and fix it.
|
|
155
|
+
The function around line 150 has the issue.
|
|
156
|
+
|
|
157
|
+
**Files to change:**
|
|
158
|
+
- src/triage/handler.ts (line 150)
|
|
159
|
+
- src/types.ts (line 42)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
This is bad because:
|
|
163
|
+
- No category
|
|
164
|
+
- Vague description ("the triage thing is broken")
|
|
165
|
+
- References file paths and line numbers that will go stale
|
|
166
|
+
- No acceptance criteria
|
|
167
|
+
- No scope boundaries
|
|
168
|
+
- No description of current vs desired behavior
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Out-of-Scope Knowledge Base
|
|
2
|
+
|
|
3
|
+
The `.out-of-scope/` directory in a repo stores persistent records of rejected feature requests. It serves two purposes:
|
|
4
|
+
|
|
5
|
+
1. **Institutional memory** — why a feature was rejected, so the reasoning isn't lost when the issue is closed
|
|
6
|
+
2. **Deduplication** — when a new issue comes in that matches a prior rejection, the skill can surface the previous decision instead of re-litigating it
|
|
7
|
+
|
|
8
|
+
## Directory structure
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
.out-of-scope/
|
|
12
|
+
├── dark-mode.md
|
|
13
|
+
├── plugin-system.md
|
|
14
|
+
└── graphql-api.md
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
One file per **concept**, not per issue. Multiple issues requesting the same thing are grouped under one file.
|
|
18
|
+
|
|
19
|
+
## File format
|
|
20
|
+
|
|
21
|
+
The file should be written in a relaxed, readable style — more like a short design document than a database entry. Use paragraphs, code samples, and examples to make the reasoning clear and useful to someone encountering it for the first time.
|
|
22
|
+
|
|
23
|
+
```markdown
|
|
24
|
+
# Dark Mode
|
|
25
|
+
|
|
26
|
+
This project does not support dark mode or user-facing theming.
|
|
27
|
+
|
|
28
|
+
## Why this is out of scope
|
|
29
|
+
|
|
30
|
+
The rendering pipeline assumes a single color palette defined in
|
|
31
|
+
`ThemeConfig`. Supporting multiple themes would require:
|
|
32
|
+
|
|
33
|
+
- A theme context provider wrapping the entire component tree
|
|
34
|
+
- Per-component theme-aware style resolution
|
|
35
|
+
- A persistence layer for user theme preferences
|
|
36
|
+
|
|
37
|
+
This is a significant architectural change that doesn't align with the
|
|
38
|
+
project's focus on content authoring. Theming is a concern for downstream
|
|
39
|
+
consumers who embed or redistribute the output.
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
// The current ThemeConfig interface is not designed for runtime switching:
|
|
43
|
+
interface ThemeConfig {
|
|
44
|
+
colors: ColorPalette; // single palette, resolved at build time
|
|
45
|
+
fonts: FontStack;
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Prior requests
|
|
50
|
+
|
|
51
|
+
- #42 — "Add dark mode support"
|
|
52
|
+
- #87 — "Night theme for accessibility"
|
|
53
|
+
- — "Dark theme option"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Naming the file
|
|
57
|
+
|
|
58
|
+
Use a short, descriptive kebab-case name for the concept: `dark-mode.md`, `plugin-system.md`, `graphql-api.md`. The name should be recognizable enough that someone browsing the directory understands what was rejected without opening the file.
|
|
59
|
+
|
|
60
|
+
### Writing the reason
|
|
61
|
+
|
|
62
|
+
The reason should be substantive — not "we don't want this" but why. Good reasons reference:
|
|
63
|
+
|
|
64
|
+
- Project scope or philosophy ("This project focuses on X; theming is a downstream concern")
|
|
65
|
+
- Technical constraints ("Supporting this would require Y, which conflicts with our Z architecture")
|
|
66
|
+
- Strategic decisions ("We chose to use A instead of B because...")
|
|
67
|
+
|
|
68
|
+
The reason should be durable. Avoid referencing temporary circumstances ("we're too busy right now") — those aren't real rejections, they're deferrals.
|
|
69
|
+
|
|
70
|
+
## When to check `.out-of-scope/`
|
|
71
|
+
|
|
72
|
+
During triage (Step 1: Gather context), read all files in `.out-of-scope/`. When evaluating a new issue:
|
|
73
|
+
|
|
74
|
+
- Check if the request matches an existing out-of-scope concept
|
|
75
|
+
- Matching is by concept similarity, not keyword — "night theme" matches `dark-mode.md`
|
|
76
|
+
- If there's a match, surface it to the maintainer: "This is similar to `.out-of-scope/dark-mode.md` — we rejected this before because [reason]. Do you still feel the same way?"
|
|
77
|
+
|
|
78
|
+
The maintainer may:
|
|
79
|
+
|
|
80
|
+
- **Confirm** — the new issue gets added to the existing file's "Prior requests" list, then closed
|
|
81
|
+
- **Reconsider** — the out-of-scope file gets deleted or updated, and the issue proceeds through normal triage
|
|
82
|
+
- **Disagree** — the issues are related but distinct, proceed with normal triage
|
|
83
|
+
|
|
84
|
+
## When to write to `.out-of-scope/`
|
|
85
|
+
|
|
86
|
+
Only when an **enhancement** (not a bug) is rejected as `wontfix`. The flow:
|
|
87
|
+
|
|
88
|
+
1. Maintainer decides a feature request is out of scope
|
|
89
|
+
2. Check if a matching `.out-of-scope/` file already exists
|
|
90
|
+
3. If yes: append the new issue to the "Prior requests" list
|
|
91
|
+
4. If no: create a new file with the concept name, decision, reason, and first prior request
|
|
92
|
+
5. Post a comment on the issue explaining the decision and mentioning the `.out-of-scope/` file
|
|
93
|
+
6. Close the issue with the `wontfix` label
|
|
94
|
+
|
|
95
|
+
## Updating or removing out-of-scope files
|
|
96
|
+
|
|
97
|
+
If the maintainer changes their mind about a previously rejected concept:
|
|
98
|
+
|
|
99
|
+
- Delete the `.out-of-scope/` file
|
|
100
|
+
- The skill does not need to reopen old issues — they're historical records
|
|
101
|
+
- The new issue that triggered the reconsideration proceeds through normal triage
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: triage
|
|
3
|
+
disable-model-invocation: true
|
|
4
|
+
description: "Triage issues through the project board workflow. Use when user wants to triage issues, review incoming bugs or feature requests, prepare issues for an AFK agent, or manage issue workflow."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Triage
|
|
8
|
+
|
|
9
|
+
Move issues on the project issue tracker through the board-driven workflow.
|
|
10
|
+
|
|
11
|
+
Every comment or issue posted to the issue tracker during triage **must** start with this disclaimer:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
> *This was generated by AI during triage.*
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Reference docs
|
|
18
|
+
|
|
19
|
+
- [AGENT-BRIEF.md](AGENT-BRIEF.md) — how to write durable agent briefs
|
|
20
|
+
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md) — how the `.out-of-scope/` knowledge base works
|
|
21
|
+
|
|
22
|
+
## Labels
|
|
23
|
+
|
|
24
|
+
### Category labels (exactly one per issue)
|
|
25
|
+
|
|
26
|
+
| Label | When |
|
|
27
|
+
|---|---|
|
|
28
|
+
| `type:bug` | Something is broken |
|
|
29
|
+
| `type:feature` | New user-facing capability |
|
|
30
|
+
| `type:followup` | Emerged from a PR / live-verify |
|
|
31
|
+
| `type:refactor` | Code-quality / structural improvement |
|
|
32
|
+
| `type:idea` | Raw idea, not yet decided |
|
|
33
|
+
| `type:research` | Investigation / spike |
|
|
34
|
+
| `type:dust` | Tech-debt / cleanup / rename |
|
|
35
|
+
| `type:cluster` | Parent issue grouping a wave |
|
|
36
|
+
|
|
37
|
+
### Required labels (both must be present after triage)
|
|
38
|
+
|
|
39
|
+
- exactly one category `type:*` (table above)
|
|
40
|
+
- `priority:high` / `priority:medium` / `priority:low`
|
|
41
|
+
|
|
42
|
+
Wave assignment is **not** a triage step. Waves originate via `board-to-waves`
|
|
43
|
+
(clustering → anchor with a Wave-number field, membership via parent link). No
|
|
44
|
+
per-issue `wave:*` label — deprecated.
|
|
45
|
+
|
|
46
|
+
### State labels (two are in active use)
|
|
47
|
+
|
|
48
|
+
- `needs-info` — waiting on reporter for more information
|
|
49
|
+
- `ready-for-agent` — fully specified, ready for an AFK agent
|
|
50
|
+
|
|
51
|
+
**Board status is authoritative** for everything else (the role arc idea → triaged → spec → inProgress → review → done, names per the profile's `fields.status.roles`). State labels are not used for `needs-triage`, `ready-for-human`, or `wontfix` — those states live in the board or are handled by closing the issue.
|
|
52
|
+
|
|
53
|
+
`ready-for-human` does not exist in this project — all implementation is done by Claude. If an issue genuinely requires <maintainer>'s judgment before Claude can act, mark it `needs-info` and ask the specific question.
|
|
54
|
+
|
|
55
|
+
## Invocation
|
|
56
|
+
|
|
57
|
+
The maintainer invokes `/triage` and describes what they want in natural language. Interpret the request and act. Examples:
|
|
58
|
+
|
|
59
|
+
- "Show me anything that needs my attention"
|
|
60
|
+
- "Let's look at #42"
|
|
61
|
+
- "Move #42 to ready-for-agent"
|
|
62
|
+
- "What's ready for agents to pick up?"
|
|
63
|
+
|
|
64
|
+
## Show what needs attention
|
|
65
|
+
|
|
66
|
+
Query the issue tracker and present three buckets, oldest first:
|
|
67
|
+
|
|
68
|
+
1. **Incomplete labels** — missing `type:*` or `priority:*`.
|
|
69
|
+
2. **Board status at the idea role** — not yet triaged.
|
|
70
|
+
3. **`needs-info` with reporter activity since the last triage notes** — needs re-evaluation.
|
|
71
|
+
|
|
72
|
+
Show counts and a one-line summary per issue. Let the maintainer pick.
|
|
73
|
+
|
|
74
|
+
## Triage a specific issue
|
|
75
|
+
|
|
76
|
+
1. **Gather context.** Read the full issue (body, comments, labels, reporter, dates). Parse any prior triage notes so you don't re-ask resolved questions. Explore the codebase using the project's domain glossary, respecting ADRs in the area. Read `.out-of-scope/*.md` and surface any prior rejection that resembles this issue.
|
|
77
|
+
|
|
78
|
+
2. **Recommend.** Tell the maintainer your category and priority recommendation with reasoning, plus a brief codebase summary relevant to the issue. Wait for direction.
|
|
79
|
+
|
|
80
|
+
3. **Reproduce (bugs only).** Before any grilling, attempt reproduction: read the reporter's steps, trace the relevant code, run tests or commands. Report what happened — successful repro with code path, failed repro, or insufficient detail (a strong `needs-info` signal). A confirmed repro makes a much stronger agent brief.
|
|
81
|
+
|
|
82
|
+
4. **Grill (if needed).** If the issue needs fleshing out, run a `/grill-with-docs` session.
|
|
83
|
+
|
|
84
|
+
5. **Apply the outcome:**
|
|
85
|
+
- `ready-for-agent` — add label, post an agent brief comment ([AGENT-BRIEF.md](AGENT-BRIEF.md)), update board status to `Triaged`.
|
|
86
|
+
- `needs-info` — add label, post triage notes (template below).
|
|
87
|
+
- "won't fix" — polite explanation comment, close issue. For enhancements write to `.out-of-scope/` first ([OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)).
|
|
88
|
+
- Ensure `type:*` and `priority:*` are set before closing the triage.
|
|
89
|
+
|
|
90
|
+
## Board sync
|
|
91
|
+
|
|
92
|
+
After every state change make sure the issue is on the board and its Status reflects the outcome — one call:
|
|
93
|
+
```bash
|
|
94
|
+
python3 scripts/board-sync.py add --issue <number> --status-role triaged
|
|
95
|
+
```
|
|
96
|
+
`add` puts the issue on the board **and** stamps the Status field in one step. Board project + field IDs are the SSOT in `docs/agents/board-sync.md` (read from the project root — Memory is invisible to Codex-side agents). Wave is **not** set here — that happens in `board-to-waves` clustering.
|
|
97
|
+
|
|
98
|
+
## Quick state override
|
|
99
|
+
|
|
100
|
+
If the maintainer says "move #42 to ready-for-agent", trust them and apply the label directly. Confirm what you're about to do (label changes, comment, board update), then act. Skip grilling. If moving to `ready-for-agent` without a grilling session, ask whether they want to write an agent brief.
|
|
101
|
+
|
|
102
|
+
## Needs-info template
|
|
103
|
+
|
|
104
|
+
```markdown
|
|
105
|
+
## Triage Notes
|
|
106
|
+
|
|
107
|
+
**What we've established so far:**
|
|
108
|
+
|
|
109
|
+
- point 1
|
|
110
|
+
- point 2
|
|
111
|
+
|
|
112
|
+
**What we still need from you (@reporter):**
|
|
113
|
+
|
|
114
|
+
- question 1
|
|
115
|
+
- question 2
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Capture everything resolved during grilling under "established so far" so the work isn't lost. Questions must be specific and actionable, not "please provide more info".
|
|
119
|
+
|
|
120
|
+
## Resuming a previous session
|
|
121
|
+
|
|
122
|
+
If prior triage notes exist on the issue, read them, check whether the reporter has answered any outstanding questions, and present an updated picture before continuing. Don't re-ask resolved questions.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Third-Party Notices
|
|
2
|
+
|
|
3
|
+
This skill is adapted from **Matt Pocock's skills**
|
|
4
|
+
(https://github.com/mattpocock/skills), `skills/engineering/triage` @ d574778, Copyright (c) 2026 Matt Pocock,
|
|
5
|
+
used under the MIT License. Locally adapted (fork-and-own); see PROVENANCE.md.
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
MIT License
|
|
9
|
+
|
|
10
|
+
Copyright (c) 2026 Matt Pocock
|
|
11
|
+
|
|
12
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
13
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
14
|
+
in the Software without restriction, including without limitation the rights
|
|
15
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
16
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
17
|
+
furnished to do so, subject to the following conditions:
|
|
18
|
+
|
|
19
|
+
The above copyright notice and this permission notice shall be included in all
|
|
20
|
+
copies or substantial portions of the Software.
|
|
21
|
+
|
|
22
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
24
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
25
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
26
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
27
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
28
|
+
SOFTWARE.
|
|
29
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: verify-spike
|
|
3
|
+
"description": "Answer a single yes/no factual question about reality with a minimal throwaway, read-only harness and output-proof. Use when a plan, ADR, or implementation hinges on an empirically-checkable fact — does a library API exist / behave this way on this version, does the runtime / DB / platform actually have this capability, does an external assumption hold — and you need a proven verdict before locking the decision. NOT for design exploration (prototype), bug root-cause (diagnose), or building a feature (tdd)."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Verify Spike
|
|
7
|
+
|
|
8
|
+
A verify-spike is **throwaway, read-only code that proves a yes/no fact about reality.** The question is binary; the spike makes the answer empirical instead of assumed.
|
|
9
|
+
|
|
10
|
+
This is the "Verify First" rule with a runnable harness behind it: when you cannot answer an externally-knowable fact from docs alone, build the smallest thing that forces reality to answer.
|
|
11
|
+
|
|
12
|
+
## When this and not another skill
|
|
13
|
+
|
|
14
|
+
| You are asking… | Skill |
|
|
15
|
+
|---|---|
|
|
16
|
+
| "Is this fact true against the real lib / runtime / DB / platform?" (yes/no) | **verify-spike** |
|
|
17
|
+
| "Which of these options, given these trade-offs?" / "I need to research this before I can choose." (bounded, sub-grill) | `decision-gate` |
|
|
18
|
+
| "Does this design / state model / UI feel right?" (open-ended) | `prototype` |
|
|
19
|
+
| "Why is this broken / slow?" (root-cause of a known defect) | `diagnose` |
|
|
20
|
+
| "Build this behaviour, test-first." (new feature/fix) | `tdd` |
|
|
21
|
+
|
|
22
|
+
If the question is really "what should this be", it is not a verify-spike — those are open, not yes/no.
|
|
23
|
+
|
|
24
|
+
## Steps
|
|
25
|
+
|
|
26
|
+
1. **Frame one falsifiable question.** Write it down as a single sentence with a yes/no answer and the exact version/context it is scoped to — e.g. "Does `customType.mapFromDriverValue` run on `drizzle-orm@1.0.0-rc.3` + node-postgres?". Name what a YES vs a NO looks like in the output *before* you run anything.
|
|
27
|
+
2. **Build the smallest harness that forces the answer.** Borrow the feedback-loop toolkit from `diagnose` Phase 1 — a one-call throwaway script, a fixture replay, a tiny HTTP/curl probe, a headless-browser assertion. Pick the cheapest one that touches the real thing (real lib version, real runtime, the actual DB read). One command to run; locate it in a clearly-throwaway path (`scratch/`, `*.spike.ts`). If a project layer exists at `docs/agents/skills/verify-spike.md`, follow its harness-placement/import rules — some repos need spikes inside a package dir so real imports resolve.
|
|
28
|
+
3. **Run it and capture the proof.** Keep the raw output — the value, the error, the stack, the HTTP status. The verdict is only as good as the evidence pasted under it.
|
|
29
|
+
4. **Record the verdict durably, with its evidence inline.** Yes/No + the proof (output snippet / `file:line` / version) + the date + the scope it was checked at. Sink it where the decision lives: an ADR, the issue body, the plan, or a PR comment. A verdict without inline evidence is just an unverified claim — keep the proof attached so a later reader does not have to re-run the spike to trust it.
|
|
30
|
+
5. **Delete the harness.** The *answer* is the only keeper. Remove the spike code (or fold the proven fact into real code) so nothing throwaway rots in the repo.
|
|
31
|
+
|
|
32
|
+
## Rules
|
|
33
|
+
|
|
34
|
+
1. **Read-only.** No schema changes, no migrations, no writes to a shared/prod resource. A DB question hits a scratch row or a read; never mutate state you did not create.
|
|
35
|
+
2. **Throwaway from line one.** No tests, no abstractions, no error handling beyond what makes it run. The spike is deleted in step 5 — do not polish it.
|
|
36
|
+
3. **Touch the real thing.** The whole point is empirical: pin the actual version, hit the actual runtime/API. A spike against a mock proves nothing.
|
|
37
|
+
4. **Evidence, not assertion.** "It works" is not a verdict. The output is.
|
|
38
|
+
5. **Scope honestly.** The answer holds only for the version/context you tested. State that scope in the verdict so a later version bump re-opens the question instead of inheriting a stale yes/no.
|
|
39
|
+
6. **No forced verdict.** A run that yields neither a clean YES nor NO (flaky, environment-dependent, ambiguous output) is *undecided* — say so, tighten the question or the harness, and re-run; never round an ambiguous result to the nearest yes/no.
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wayfinder
|
|
3
|
+
description: "Plan a huge chunk of work — more than one agent session can hold — as a shared map of investigation tickets on your issue tracker, and resolve them one at a time until the way to the destination is clear."
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
A loose idea has arrived — too big for one agent session, and wrapped in fog: the way from here to the **destination** isn't visible yet. Wayfinding is about finding that way, not charging at the destination. This skill charts the way as a **shared map** on the repo's issue tracker, then works its tickets one at a time until the route is clear.
|
|
8
|
+
|
|
9
|
+
The destination varies per effort, and naming it is the first act of charting — it shapes every ticket. It might be a spec to hand off and iterate on, a decision to lock before planning starts, or a change made in place like a data-structure migration. The map is domain-agnostic — engineering work, course content, whatever fits the shape.
|
|
10
|
+
|
|
11
|
+
## Plan, don't do
|
|
12
|
+
|
|
13
|
+
Wayfinder is **planning** by default: each ticket resolves a decision, and the map is done when the way is clear — nothing left to decide before someone goes and does the thing. The pull to just do the work is usually the signal you've reached the edge of the map and it's time to hand off. An effort can override this in its **Notes** — carrying execution into the map itself — but absent that, produce decisions, not deliverables.
|
|
14
|
+
|
|
15
|
+
## Refer by name
|
|
16
|
+
|
|
17
|
+
Every map and ticket is an issue, so it has a **name** — its title. In everything the human reads — narration, the map's Decisions-so-far — refer to it by that name, never by a bare id, number, or slug. A wall of `#42, #43, #44` is illegible; names read at a glance. The id and URL don't vanish — a name wraps its link — but they ride *inside* the name, never stand in for it.
|
|
18
|
+
|
|
19
|
+
## The Map
|
|
20
|
+
|
|
21
|
+
The map is a single issue on this repo's issue tracker, labelled `wayfinder:map` — the canonical artifact. Its tickets are child issues of the map.
|
|
22
|
+
|
|
23
|
+
The map is an **index**, not a store. It lists the decisions made and points at the tickets that hold their detail; a decision lives in exactly one place — its ticket — so the map never restates it, only gists it and links.
|
|
24
|
+
|
|
25
|
+
**Where the map, its child tickets, blocking, and frontier queries physically live is tracker-specific.** The issue tracker should have been provided to you — run `/setup-workflow` if not. Consult the tracker doc's "Wayfinding operations" section for how _this_ repo expresses them. If no tracker has been provided, default to the local-markdown tracker.
|
|
26
|
+
|
|
27
|
+
### The map body
|
|
28
|
+
|
|
29
|
+
The whole map at low resolution, loaded once per session. Open tickets are **not** listed — they are open child issues, found by query.
|
|
30
|
+
|
|
31
|
+
```markdown
|
|
32
|
+
## Destination
|
|
33
|
+
|
|
34
|
+
<what reaching the end of this map looks like — the spec, decision, or change this effort is finding its way to. One or two lines; every session orients to it before choosing a ticket.>
|
|
35
|
+
|
|
36
|
+
## Notes
|
|
37
|
+
|
|
38
|
+
<domain; skills every session should consult; standing preferences for this effort>
|
|
39
|
+
|
|
40
|
+
## Decisions so far
|
|
41
|
+
|
|
42
|
+
<!-- the index — one line per closed ticket: enough to judge relevance, then zoom the link for the detail the ticket holds -->
|
|
43
|
+
|
|
44
|
+
- [<closed ticket title>](link) — <one-line gist of the answer>
|
|
45
|
+
|
|
46
|
+
## Not yet specified
|
|
47
|
+
|
|
48
|
+
<!-- see "Fog of war": in-scope fog you can't ticket yet; graduates as the frontier advances -->
|
|
49
|
+
|
|
50
|
+
## Out of scope
|
|
51
|
+
|
|
52
|
+
<!-- see "Out of scope": work ruled beyond the destination; closed, never graduates -->
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Tickets
|
|
56
|
+
|
|
57
|
+
Each ticket is a **child issue** of the map; the tracker's issue id is its identity. Its body is the question, sized to one 100K token agent session:
|
|
58
|
+
|
|
59
|
+
```markdown
|
|
60
|
+
## Question
|
|
61
|
+
|
|
62
|
+
<the decision or investigation this ticket resolves>
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Each ticket carries a `wayfinder:<type>` label — one of `research`, `prototype`, `grilling`, `task` (see [Ticket Types](#ticket-types)).
|
|
66
|
+
|
|
67
|
+
A session **claims** a ticket by assigning it to the dev driving the map, **first**, before any work, so concurrent sessions skip it. That assignee _is_ the claim: an open, unassigned ticket is unclaimed.
|
|
68
|
+
|
|
69
|
+
Blocking uses the tracker's **native** dependency relationship — essential because it renders the frontier _visually_ in the tracker's own UI, so the human sees what's takeable without opening the map. Only a tracker that lacks native blocking falls back to a body convention. A ticket is **unblocked** when every ticket blocking it is closed; the **frontier** is the open, unblocked, unclaimed children — the edge of the known.
|
|
70
|
+
|
|
71
|
+
The answer isn't part of the body — it's recorded on resolution (see [Work through the map](#work-through-the-map)). Assets created while resolving a ticket are linked from the issue, not pasted in.
|
|
72
|
+
|
|
73
|
+
## Ticket Types
|
|
74
|
+
|
|
75
|
+
Every ticket is either **HITL** — human in the loop, worked *with* a human who speaks for themselves — or **AFK**, driven by the agent alone. A HITL ticket only resolves through that live exchange; the agent never stands in for the human's side of it (a grilling agent that answers its own questions has broken this).
|
|
76
|
+
|
|
77
|
+
- **Research** (AFK): Reading documentation, third-party APIs, or local resources like knowledge bases. Creates a markdown summary as a linked asset. Use when knowledge outside the current working directory is required.
|
|
78
|
+
- **Prototype** (HITL): Raise the fidelity of the discussion by making a cheap, rough, concrete artifact to react to — an outline, a rough take, a stub, or UI/logic code via the /prototype skill. Links the prototype as an asset. Use when "how should it look" or "how should it behave" is the key question.
|
|
79
|
+
- **Grilling** (HITL): Conversation via the /grill-me and /domain-modeling skills, one question at a time. The default case.
|
|
80
|
+
- **Task** (HITL or AFK): Manual work that must happen before a *decision* can be made — nothing to decide, prototype, or research, but the discussion is blocked until it's done. Signing up for a service so its API can be judged, provisioning access, moving data so its shape can be seen. This is the one type that *does* rather than decides — and it earns its place by unblocking a decision, not by delivering the destination. The agent drives it alone where it can (AFK); otherwise it hands the human a precise checklist (HITL). Resolved when the work is done; the answer records what was done and any resulting facts (credentials location, new URLs, row counts) later tickets depend on.
|
|
81
|
+
|
|
82
|
+
## Fog of war
|
|
83
|
+
|
|
84
|
+
The map is _deliberately_ incomplete: don't chart what you can't yet see. Beyond the live tickets lies the **fog of war** — the dim view of decisions and investigations you can tell are coming but can't yet pin down, because they hang on questions still open. Resolving a ticket clears the fog ahead of it, graduating whatever's now specifiable into fresh tickets — one at a time, until the way to the destination is clear and no tickets remain.
|
|
85
|
+
|
|
86
|
+
The map's **Not yet specified** section is where that dim view is written down: the suspected question, the area to revisit later. It's the undiscovered frontier _toward_ the destination — everything here is in scope, just not sharp enough to ticket. Write as loosely or as fully as the view allows; it doubles as a signpost for collaborators reading where the effort is headed.
|
|
87
|
+
|
|
88
|
+
**Fog or ticket?** The test is whether you can state the question precisely now — _not_ whether you can answer it now.
|
|
89
|
+
|
|
90
|
+
- **Ticket when** the question is already sharp — even if it's blocked and you can't act on it yet.
|
|
91
|
+
- **Not yet specified when** you can't yet phrase it that sharply. Don't pre-slice the fog into ticket-sized pieces: it's coarser than a ticket, and one patch may graduate into several tickets, or none, once the frontier reaches it.
|
|
92
|
+
|
|
93
|
+
**Not yet specified** excludes what's already decided (Decisions so far), what's already a live ticket, and what's out of scope (the next section).
|
|
94
|
+
|
|
95
|
+
## Out of scope
|
|
96
|
+
|
|
97
|
+
Fog only ever gathers _toward_ the destination. The destination fixes the scope, so work beyond it is **out of scope** — it isn't fog, and it doesn't belong in **Not yet specified**. It gets its own **Out of scope** section on the map: work you've consciously ruled out of _this_ effort. Scope, not sharpness, lands it here.
|
|
98
|
+
|
|
99
|
+
Out-of-scope work never graduates — the frontier stops at the destination — so it returns only if the destination is redrawn, and then as a fresh effort, not a resumption.
|
|
100
|
+
|
|
101
|
+
Ruling something out of scope is a scoping act, not a step on the route. When a ticket that already exists turns out to sit past the destination — mis-scoped in while charting, or exposed by a resolution — **close it** (a closed ticket is unambiguously off the frontier) and leave one line in the **Out of scope** section: the gist plus why it's out of scope, linking the closed ticket. It stays out of **Decisions so far**, which records the route actually walked — a scope boundary isn't a step on it.
|
|
102
|
+
|
|
103
|
+
## Invocation
|
|
104
|
+
|
|
105
|
+
Two modes. Either way, **never resolve more than one ticket per session.**
|
|
106
|
+
|
|
107
|
+
### Chart the map
|
|
108
|
+
|
|
109
|
+
User invokes with a loose idea.
|
|
110
|
+
|
|
111
|
+
1. **Name the destination.** Run a `/grill-me` and `/domain-modeling` session to pin down what this map is finding its way to — the spec, decision, or change. The destination fixes the scope, so it's settled first.
|
|
112
|
+
2. **Map the frontier.** Grill again, **breadth-first** this time: fan out across the whole space rather than deep on any one thread, surfacing the open decisions and the first steps takeable now. **If this surfaces no fog** — the way to the destination is already clear, the whole journey small enough for one session — you don't need a map. Stop and ask the user how they'd like to proceed.
|
|
113
|
+
3. **Create the map** (label `wayfinder:map`): Destination and Notes filled in, Decisions-so-far empty, the fog sketched into **Not yet specified**.
|
|
114
|
+
4. **Create the tickets you can specify now** as child issues of the map — then wire blocking edges in a **second pass** (issues need ids before they can reference each other). Wiring sorts them into the frontier and the blocked; everything you can't yet specify stays in the fog — the **Not yet specified** section.
|
|
115
|
+
5. Stop — charting the map is one session's work; do not also resolve tickets.
|
|
116
|
+
|
|
117
|
+
### Work through the map
|
|
118
|
+
|
|
119
|
+
User invokes with a map (URL or number). A ticket is **optional** — without one, you pick the next decision, not the user.
|
|
120
|
+
|
|
121
|
+
1. Load the **map** — the low-res view, not every ticket body.
|
|
122
|
+
2. Choose the ticket. If the user named one, use it. Otherwise take the first frontier ticket in order. **Claim it**: assign it to yourself before any work.
|
|
123
|
+
3. Resolve it — **zoom as needed**: fetch the full body of any related or closed ticket on demand; invoke the skills the `## Notes` block names. If in doubt, use `/grill-me` and `/domain-modeling`.
|
|
124
|
+
4. Record the resolution: post the answer as a **resolution comment**, **close** the issue, and **append a context pointer** to the map's Decisions-so-far.
|
|
125
|
+
5. Add newly-surfaced tickets (create-then-wire); graduate any fog the answer has made specifiable, clearing each graduated patch from **Not yet specified** so it lives only as its new ticket. If the answer reveals a ticket — this one or another — sits beyond the destination, **rule it out of scope** rather than resolving it on the route. If the decision invalidates other parts of the map, update or delete those tickets.
|
|
126
|
+
|
|
127
|
+
The user may run unblocked tickets in parallel, so expect other sessions to be editing the tracker concurrently.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Third-Party Notices
|
|
2
|
+
|
|
3
|
+
This skill is adapted from **Matt Pocock's skills**
|
|
4
|
+
(https://github.com/mattpocock/skills), `skills/engineering/wayfinder` @ d574778, Copyright (c) 2026 Matt Pocock,
|
|
5
|
+
used under the MIT License. Locally adapted (fork-and-own); see PROVENANCE.md.
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
MIT License
|
|
9
|
+
|
|
10
|
+
Copyright (c) 2026 Matt Pocock
|
|
11
|
+
|
|
12
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
13
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
14
|
+
in the Software without restriction, including without limitation the rights
|
|
15
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
16
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
17
|
+
furnished to do so, subject to the following conditions:
|
|
18
|
+
|
|
19
|
+
The above copyright notice and this permission notice shall be included in all
|
|
20
|
+
copies or substantial portions of the Software.
|
|
21
|
+
|
|
22
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
23
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
24
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
25
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
26
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
27
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
28
|
+
SOFTWARE.
|
|
29
|
+
```
|