memorable-kg 0.0.1__tar.gz
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.
- memorable_kg-0.0.1/.agents/skills/caveman/SKILL.md +49 -0
- memorable_kg-0.0.1/.agents/skills/grill-me/SKILL.md +10 -0
- memorable_kg-0.0.1/.agents/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- memorable_kg-0.0.1/.agents/skills/grill-with-docs/CONTEXT-FORMAT.md +63 -0
- memorable_kg-0.0.1/.agents/skills/grill-with-docs/SKILL.md +88 -0
- memorable_kg-0.0.1/.agents/skills/handoff/SKILL.md +15 -0
- memorable_kg-0.0.1/.agents/skills/prototype/LOGIC.md +79 -0
- memorable_kg-0.0.1/.agents/skills/prototype/SKILL.md +30 -0
- memorable_kg-0.0.1/.agents/skills/prototype/UI.md +112 -0
- memorable_kg-0.0.1/.agents/skills/to-issues/SKILL.md +83 -0
- memorable_kg-0.0.1/.agents/skills/to-prd/SKILL.md +76 -0
- memorable_kg-0.0.1/.agents/skills/triage/AGENT-BRIEF.md +168 -0
- memorable_kg-0.0.1/.agents/skills/triage/OUT-OF-SCOPE.md +101 -0
- memorable_kg-0.0.1/.agents/skills/triage/SKILL.md +103 -0
- memorable_kg-0.0.1/.agents/skills/write-a-skill/SKILL.md +117 -0
- memorable_kg-0.0.1/.claude/agents/architect.md +82 -0
- memorable_kg-0.0.1/.claude/agents/python-developer.md +79 -0
- memorable_kg-0.0.1/.claude/settings.json +20 -0
- memorable_kg-0.0.1/.claude/skills/implement-slice/SKILL.md +43 -0
- memorable_kg-0.0.1/.claude/skills/implement-slice/WORKFLOW.md +149 -0
- memorable_kg-0.0.1/.claude/skills/project-code-review/RULES.md +107 -0
- memorable_kg-0.0.1/.claude/skills/project-code-review/SKILL.md +47 -0
- memorable_kg-0.0.1/.claude/skills/setup-matt-pocock-skills +1 -0
- memorable_kg-0.0.1/.claude/skills/tdd/SKILL.md +138 -0
- memorable_kg-0.0.1/.claude/skills/tdd/deep-modules.md +42 -0
- memorable_kg-0.0.1/.claude/skills/tdd/interface-design.md +65 -0
- memorable_kg-0.0.1/.claude/skills/tdd/mocking.md +86 -0
- memorable_kg-0.0.1/.claude/skills/tdd/refactoring.md +12 -0
- memorable_kg-0.0.1/.claude/skills/tdd/tests.md +67 -0
- memorable_kg-0.0.1/.github/workflows/ci.yml +101 -0
- memorable_kg-0.0.1/.github/workflows/release.yml +166 -0
- memorable_kg-0.0.1/.gitignore +14 -0
- memorable_kg-0.0.1/.sandcastle/.gitignore +4 -0
- memorable_kg-0.0.1/.sandcastle/Dockerfile +32 -0
- memorable_kg-0.0.1/.sandcastle/README.md +79 -0
- memorable_kg-0.0.1/.sandcastle/implement-prd.ts +1874 -0
- memorable_kg-0.0.1/CLAUDE.md +42 -0
- memorable_kg-0.0.1/PKG-INFO +123 -0
- memorable_kg-0.0.1/README.md +99 -0
- memorable_kg-0.0.1/docs/adr/0001-direct-neo4j-first.md +77 -0
- memorable_kg-0.0.1/docs/adr/0002-project-memory-profiles.md +183 -0
- memorable_kg-0.0.1/docs/adr/0003-temporal-memory-records.md +75 -0
- memorable_kg-0.0.1/docs/adr/0004-mcp-first-agent-interface.md +59 -0
- memorable_kg-0.0.1/docs/adr/0005-local-neo4j-runtime.md +90 -0
- memorable_kg-0.0.1/docs/adr/0006-primary-implementation-language.md +96 -0
- memorable_kg-0.0.1/docs/adr/0007-hybrid-graphrag-retrieval.md +93 -0
- memorable_kg-0.0.1/docs/adr/0008-product-packaging.md +94 -0
- memorable_kg-0.0.1/docs/adr/0009-thin-repositories-temporal-logic-in-services.md +80 -0
- memorable_kg-0.0.1/docs/adr/0010-three-layer-runtime-configuration.md +129 -0
- memorable_kg-0.0.1/docs/adr/0011-correction-updates-in-place.md +59 -0
- memorable_kg-0.0.1/docs/adr/0012-relation-stored-as-node-with-structural-edges.md +50 -0
- memorable_kg-0.0.1/docs/adr/0013-fastembed-default-local-embedding-provider.md +85 -0
- memorable_kg-0.0.1/docs/adr/0014-write-policy-removed-from-v1.md +55 -0
- memorable_kg-0.0.1/docs/adr/0015-event-as-record-deferred.md +51 -0
- memorable_kg-0.0.1/docs/adr/0016-uniform-live-command-config-resolution.md +74 -0
- memorable_kg-0.0.1/docs/agents/domain.md +37 -0
- memorable_kg-0.0.1/docs/agents/issue-tracker.md +22 -0
- memorable_kg-0.0.1/docs/agents/triage-labels.md +13 -0
- memorable_kg-0.0.1/docs/product.md +135 -0
- memorable_kg-0.0.1/docs/release-version-ladder.md +38 -0
- memorable_kg-0.0.1/docs/researches/graphiti-vs-neo4j-decision.md +212 -0
- memorable_kg-0.0.1/docs/ubiquitous-language.md +492 -0
- memorable_kg-0.0.1/package.json +22 -0
- memorable_kg-0.0.1/pnpm-lock.yaml +392 -0
- memorable_kg-0.0.1/pnpm-workspace.yaml +2 -0
- memorable_kg-0.0.1/pyproject.toml +57 -0
- memorable_kg-0.0.1/scripts/assert_release_version.py +51 -0
- memorable_kg-0.0.1/scripts/v1_acceptance.py +568 -0
- memorable_kg-0.0.1/skills-lock.json +65 -0
- memorable_kg-0.0.1/src/memorable/__init__.py +5 -0
- memorable_kg-0.0.1/src/memorable/cli.py +1294 -0
- memorable_kg-0.0.1/src/memorable/config/__init__.py +217 -0
- memorable_kg-0.0.1/src/memorable/core/__init__.py +3 -0
- memorable_kg-0.0.1/src/memorable/core/application.py +1038 -0
- memorable_kg-0.0.1/src/memorable/core/context.py +111 -0
- memorable_kg-0.0.1/src/memorable/core/models.py +198 -0
- memorable_kg-0.0.1/src/memorable/core/ports.py +272 -0
- memorable_kg-0.0.1/src/memorable/core/profile.py +181 -0
- memorable_kg-0.0.1/src/memorable/core/profile_scaffold.py +37 -0
- memorable_kg-0.0.1/src/memorable/core/repositories.py +250 -0
- memorable_kg-0.0.1/src/memorable/core/temporal.py +28 -0
- memorable_kg-0.0.1/src/memorable/core/tracer.py +275 -0
- memorable_kg-0.0.1/src/memorable/mcp/__init__.py +3 -0
- memorable_kg-0.0.1/src/memorable/mcp/__main__.py +22 -0
- memorable_kg-0.0.1/src/memorable/mcp/server.py +1004 -0
- memorable_kg-0.0.1/src/memorable/retrieval/__init__.py +7 -0
- memorable_kg-0.0.1/src/memorable/retrieval/embeddings.py +231 -0
- memorable_kg-0.0.1/src/memorable/retrieval/index.py +58 -0
- memorable_kg-0.0.1/src/memorable/retrieval/indexable_text.py +52 -0
- memorable_kg-0.0.1/src/memorable/retrieval/models.py +52 -0
- memorable_kg-0.0.1/src/memorable/retrieval/service.py +799 -0
- memorable_kg-0.0.1/src/memorable/runtime/__init__.py +3 -0
- memorable_kg-0.0.1/src/memorable/runtime/docker-compose.yml +16 -0
- memorable_kg-0.0.1/src/memorable/runtime/docker.py +169 -0
- memorable_kg-0.0.1/src/memorable/runtime/doctor.py +287 -0
- memorable_kg-0.0.1/src/memorable/storage/__init__.py +3 -0
- memorable_kg-0.0.1/src/memorable/storage/neo4j/__init__.py +3 -0
- memorable_kg-0.0.1/src/memorable/storage/neo4j/config.py +37 -0
- memorable_kg-0.0.1/src/memorable/storage/neo4j/repository.py +1161 -0
- memorable_kg-0.0.1/src/memorable/storage/neo4j/schema.py +80 -0
- memorable_kg-0.0.1/src/memorable/storage/production.py +64 -0
- memorable_kg-0.0.1/tests/conftest.py +53 -0
- memorable_kg-0.0.1/tests/test_assert_release_version.py +46 -0
- memorable_kg-0.0.1/tests/test_build_retrieval_service.py +39 -0
- memorable_kg-0.0.1/tests/test_ci_python_baseline.py +22 -0
- memorable_kg-0.0.1/tests/test_cli_production_wiring.py +681 -0
- memorable_kg-0.0.1/tests/test_cli_remember_relation.py +495 -0
- memorable_kg-0.0.1/tests/test_correct.py +862 -0
- memorable_kg-0.0.1/tests/test_db_commands.py +144 -0
- memorable_kg-0.0.1/tests/test_db_status.py +125 -0
- memorable_kg-0.0.1/tests/test_decision_supersession.py +1716 -0
- memorable_kg-0.0.1/tests/test_docker_runtime.py +295 -0
- memorable_kg-0.0.1/tests/test_doctor.py +548 -0
- memorable_kg-0.0.1/tests/test_embedding_provider.py +379 -0
- memorable_kg-0.0.1/tests/test_entity_provenance.py +687 -0
- memorable_kg-0.0.1/tests/test_fastembed_provider.py +167 -0
- memorable_kg-0.0.1/tests/test_hybrid_retrieval.py +1836 -0
- memorable_kg-0.0.1/tests/test_init_quickstart_boundary.py +194 -0
- memorable_kg-0.0.1/tests/test_init_through_context.py +112 -0
- memorable_kg-0.0.1/tests/test_invalidate.py +597 -0
- memorable_kg-0.0.1/tests/test_language_boundary.py +124 -0
- memorable_kg-0.0.1/tests/test_list_records.py +963 -0
- memorable_kg-0.0.1/tests/test_mcp_entry_points.py +126 -0
- memorable_kg-0.0.1/tests/test_mcp_init_through_context.py +49 -0
- memorable_kg-0.0.1/tests/test_mcp_production_wiring.py +281 -0
- memorable_kg-0.0.1/tests/test_mcp_record_type_dispatch.py +83 -0
- memorable_kg-0.0.1/tests/test_mcp_remember_relation.py +344 -0
- memorable_kg-0.0.1/tests/test_mcp_server_wiring.py +274 -0
- memorable_kg-0.0.1/tests/test_mcp_stdio_integration.py +184 -0
- memorable_kg-0.0.1/tests/test_memory_profile.py +414 -0
- memorable_kg-0.0.1/tests/test_memory_space.py +68 -0
- memorable_kg-0.0.1/tests/test_neo4j_adapter.py +1669 -0
- memorable_kg-0.0.1/tests/test_neo4j_config.py +46 -0
- memorable_kg-0.0.1/tests/test_neo4j_integration.py +780 -0
- memorable_kg-0.0.1/tests/test_neo4j_observation_adapter.py +80 -0
- memorable_kg-0.0.1/tests/test_observation.py +856 -0
- memorable_kg-0.0.1/tests/test_observation_repository_contract.py +306 -0
- memorable_kg-0.0.1/tests/test_production_context.py +247 -0
- memorable_kg-0.0.1/tests/test_profile_scaffold.py +45 -0
- memorable_kg-0.0.1/tests/test_readme_quickstart.py +41 -0
- memorable_kg-0.0.1/tests/test_record_type_parameter.py +230 -0
- memorable_kg-0.0.1/tests/test_relation.py +189 -0
- memorable_kg-0.0.1/tests/test_relation_repository.py +1174 -0
- memorable_kg-0.0.1/tests/test_relation_retrieval.py +780 -0
- memorable_kg-0.0.1/tests/test_release_version_ladder_doc.py +24 -0
- memorable_kg-0.0.1/tests/test_repository_cleanup.py +50 -0
- memorable_kg-0.0.1/tests/test_runtime_config.py +406 -0
- memorable_kg-0.0.1/tests/test_shared_temporal_repository.py +316 -0
- memorable_kg-0.0.1/tests/test_space_inference.py +92 -0
- memorable_kg-0.0.1/tests/test_task_lifecycle.py +974 -0
- memorable_kg-0.0.1/tests/test_temporal_record_protocol.py +354 -0
- memorable_kg-0.0.1/tests/test_tracer.py +261 -0
- memorable_kg-0.0.1/tests/test_v1_acceptance_flow.py +46 -0
- memorable_kg-0.0.1/tests/test_walking_skeleton.py +82 -0
- memorable_kg-0.0.1/tsconfig.json +13 -0
- memorable_kg-0.0.1/uv.lock +1159 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: caveman
|
|
3
|
+
description: >
|
|
4
|
+
Ultra-compressed communication mode. Cuts token usage ~75% by dropping
|
|
5
|
+
filler, articles, and pleasantries while keeping full technical accuracy.
|
|
6
|
+
Use when user says "caveman mode", "talk like caveman", "use caveman",
|
|
7
|
+
"less tokens", "be brief", or invokes /caveman.
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Respond terse like smart caveman. All technical substance stay. Only fluff die.
|
|
11
|
+
|
|
12
|
+
## Persistence
|
|
13
|
+
|
|
14
|
+
ACTIVE EVERY RESPONSE once triggered. No revert after many turns. No filler drift. Still active if unsure. Off only when user says "stop caveman" or "normal mode".
|
|
15
|
+
|
|
16
|
+
## Rules
|
|
17
|
+
|
|
18
|
+
Drop: articles (a/an/the), filler (just/really/basically/actually/simply), pleasantries (sure/certainly/of course/happy to), hedging. Fragments OK. Short synonyms (big not extensive, fix not "implement a solution for"). Abbreviate common terms (DB/auth/config/req/res/fn/impl). Strip conjunctions. Use arrows for causality (X -> Y). One word when one word enough.
|
|
19
|
+
|
|
20
|
+
Technical terms stay exact. Code blocks unchanged. Errors quoted exact.
|
|
21
|
+
|
|
22
|
+
Pattern: `[thing] [action] [reason]. [next step].`
|
|
23
|
+
|
|
24
|
+
Not: "Sure! I'd be happy to help you with that. The issue you're experiencing is likely caused by..."
|
|
25
|
+
Yes: "Bug in auth middleware. Token expiry check use `<` not `<=`. Fix:"
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
**"Why React component re-render?"**
|
|
30
|
+
|
|
31
|
+
> Inline obj prop -> new ref -> re-render. `useMemo`.
|
|
32
|
+
|
|
33
|
+
**"Explain database connection pooling."**
|
|
34
|
+
|
|
35
|
+
> Pool = reuse DB conn. Skip handshake -> fast under load.
|
|
36
|
+
|
|
37
|
+
## Auto-Clarity Exception
|
|
38
|
+
|
|
39
|
+
Drop caveman temporarily for: security warnings, irreversible action confirmations, multi-step sequences where fragment order risks misread, user asks to clarify or repeats question. Resume caveman after clear part done.
|
|
40
|
+
|
|
41
|
+
Example -- destructive op:
|
|
42
|
+
|
|
43
|
+
> **Warning:** This will permanently delete all rows in the `users` table and cannot be undone.
|
|
44
|
+
>
|
|
45
|
+
> ```sql
|
|
46
|
+
> DROP TABLE users;
|
|
47
|
+
> ```
|
|
48
|
+
>
|
|
49
|
+
> Caveman resume. Verify backup exist first.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grill-me
|
|
3
|
+
description: Interview the user relentlessly about a plan or design until reaching shared understanding, resolving each branch of the decision tree. Use when user wants to stress-test a plan, get grilled on their design, or mentions "grill me".
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Interview me relentlessly about every aspect of this plan until we reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one. For each question, provide your recommended answer.
|
|
7
|
+
|
|
8
|
+
Ask the questions one at a time.
|
|
9
|
+
|
|
10
|
+
If a question can be answered by exploring the codebase, explore the codebase instead.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ADR Format
|
|
2
|
+
|
|
3
|
+
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
|
4
|
+
|
|
5
|
+
Create the `docs/adr/` directory lazily — only when the first ADR is needed.
|
|
6
|
+
|
|
7
|
+
## Template
|
|
8
|
+
|
|
9
|
+
```md
|
|
10
|
+
# {Short title of the decision}
|
|
11
|
+
|
|
12
|
+
{1-3 sentences: what's the context, what did we decide, and why.}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why* — not in filling out sections.
|
|
16
|
+
|
|
17
|
+
## Optional sections
|
|
18
|
+
|
|
19
|
+
Only include these when they add genuine value. Most ADRs won't need them.
|
|
20
|
+
|
|
21
|
+
- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`) — useful when decisions are revisited
|
|
22
|
+
- **Considered Options** — only when the rejected alternatives are worth remembering
|
|
23
|
+
- **Consequences** — only when non-obvious downstream effects need to be called out
|
|
24
|
+
|
|
25
|
+
## Numbering
|
|
26
|
+
|
|
27
|
+
Scan `docs/adr/` for the highest existing number and increment by one.
|
|
28
|
+
|
|
29
|
+
## When to offer an ADR
|
|
30
|
+
|
|
31
|
+
All three of these must be true:
|
|
32
|
+
|
|
33
|
+
1. **Hard to reverse** — the cost of changing your mind later is meaningful
|
|
34
|
+
2. **Surprising without context** — a future reader will look at the code and wonder "why on earth did they do it this way?"
|
|
35
|
+
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
|
|
36
|
+
|
|
37
|
+
If a decision is easy to reverse, skip it — you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
|
|
38
|
+
|
|
39
|
+
### What qualifies
|
|
40
|
+
|
|
41
|
+
- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
|
|
42
|
+
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
|
|
43
|
+
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library — just the ones that would take a quarter to swap out.
|
|
44
|
+
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
|
|
45
|
+
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
|
|
46
|
+
- **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
|
|
47
|
+
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it — otherwise someone will suggest GraphQL again in six months.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# CONTEXT.md Format
|
|
2
|
+
|
|
3
|
+
## Structure
|
|
4
|
+
|
|
5
|
+
```md
|
|
6
|
+
# {Context Name}
|
|
7
|
+
|
|
8
|
+
{One or two sentence description of what this context is and why it exists.}
|
|
9
|
+
|
|
10
|
+
## Language
|
|
11
|
+
|
|
12
|
+
**Order**:
|
|
13
|
+
{A one or two sentence description of the term}
|
|
14
|
+
_Avoid_: Purchase, transaction
|
|
15
|
+
|
|
16
|
+
**Invoice**:
|
|
17
|
+
A request for payment sent to a customer after delivery.
|
|
18
|
+
_Avoid_: Bill, payment request
|
|
19
|
+
|
|
20
|
+
**Customer**:
|
|
21
|
+
A person or organization that places orders.
|
|
22
|
+
_Avoid_: Client, buyer, account
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Rules
|
|
26
|
+
|
|
27
|
+
- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others as aliases to avoid.
|
|
28
|
+
- **Flag conflicts explicitly.** If a term is used ambiguously, call it out in "Flagged ambiguities" with a clear resolution.
|
|
29
|
+
- **Keep definitions tight.** One or two sentences max. Define what it IS, not what it does.
|
|
30
|
+
- **Show relationships.** Use bold term names and express cardinality where obvious.
|
|
31
|
+
- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
|
|
32
|
+
- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
|
|
33
|
+
- **Write an example dialogue.** A conversation between a dev and a domain expert that demonstrates how the terms interact naturally and clarifies boundaries between related concepts.
|
|
34
|
+
|
|
35
|
+
## Single vs multi-context repos
|
|
36
|
+
|
|
37
|
+
**Single context (most repos):** One `CONTEXT.md` at the repo root.
|
|
38
|
+
|
|
39
|
+
**Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
|
|
40
|
+
|
|
41
|
+
```md
|
|
42
|
+
# Context Map
|
|
43
|
+
|
|
44
|
+
## Contexts
|
|
45
|
+
|
|
46
|
+
- [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
|
|
47
|
+
- [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
|
|
48
|
+
- [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping
|
|
49
|
+
|
|
50
|
+
## Relationships
|
|
51
|
+
|
|
52
|
+
- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
|
|
53
|
+
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
|
|
54
|
+
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The skill infers which structure applies:
|
|
58
|
+
|
|
59
|
+
- If `CONTEXT-MAP.md` exists, read it to find contexts
|
|
60
|
+
- If only a root `CONTEXT.md` exists, single context
|
|
61
|
+
- If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved
|
|
62
|
+
|
|
63
|
+
When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: grill-with-docs
|
|
3
|
+
description: Grilling session that challenges your plan against the existing domain model, sharpens terminology, and updates documentation (CONTEXT.md, ADRs) inline as decisions crystallise. Use when user wants to stress-test a plan against their project's language and documented decisions.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<what-to-do>
|
|
7
|
+
|
|
8
|
+
Interview me relentlessly about every aspect of this plan until we reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one. For each question, provide your recommended answer.
|
|
9
|
+
|
|
10
|
+
Ask the questions one at a time, waiting for feedback on each question before continuing.
|
|
11
|
+
|
|
12
|
+
If a question can be answered by exploring the codebase, explore the codebase instead.
|
|
13
|
+
|
|
14
|
+
</what-to-do>
|
|
15
|
+
|
|
16
|
+
<supporting-info>
|
|
17
|
+
|
|
18
|
+
## Domain awareness
|
|
19
|
+
|
|
20
|
+
During codebase exploration, also look for existing documentation:
|
|
21
|
+
|
|
22
|
+
### File structure
|
|
23
|
+
|
|
24
|
+
Most repos have a single context:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
/
|
|
28
|
+
├── CONTEXT.md
|
|
29
|
+
├── docs/
|
|
30
|
+
│ └── adr/
|
|
31
|
+
│ ├── 0001-event-sourced-orders.md
|
|
32
|
+
│ └── 0002-postgres-for-write-model.md
|
|
33
|
+
└── src/
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
If a `CONTEXT-MAP.md` exists at the root, the repo has multiple contexts. The map points to where each one lives:
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
/
|
|
40
|
+
├── CONTEXT-MAP.md
|
|
41
|
+
├── docs/
|
|
42
|
+
│ └── adr/ ← system-wide decisions
|
|
43
|
+
├── src/
|
|
44
|
+
│ ├── ordering/
|
|
45
|
+
│ │ ├── CONTEXT.md
|
|
46
|
+
│ │ └── docs/adr/ ← context-specific decisions
|
|
47
|
+
│ └── billing/
|
|
48
|
+
│ ├── CONTEXT.md
|
|
49
|
+
│ └── docs/adr/
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Create files lazily — only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.
|
|
53
|
+
|
|
54
|
+
## During the session
|
|
55
|
+
|
|
56
|
+
### Challenge against the glossary
|
|
57
|
+
|
|
58
|
+
When the user uses a term that conflicts with the existing language in `CONTEXT.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y — which is it?"
|
|
59
|
+
|
|
60
|
+
### Sharpen fuzzy language
|
|
61
|
+
|
|
62
|
+
When the user uses vague or overloaded terms, propose a precise canonical term. "You're saying 'account' — do you mean the Customer or the User? Those are different things."
|
|
63
|
+
|
|
64
|
+
### Discuss concrete scenarios
|
|
65
|
+
|
|
66
|
+
When domain relationships are being discussed, stress-test them with specific scenarios. Invent scenarios that probe edge cases and force the user to be precise about the boundaries between concepts.
|
|
67
|
+
|
|
68
|
+
### Cross-reference with code
|
|
69
|
+
|
|
70
|
+
When the user states how something works, check whether the code agrees. If you find a contradiction, surface it: "Your code cancels entire Orders, but you just said partial cancellation is possible — which is right?"
|
|
71
|
+
|
|
72
|
+
### Update CONTEXT.md inline
|
|
73
|
+
|
|
74
|
+
When a term is resolved, update `CONTEXT.md` right there. Don't batch these up — capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
|
|
75
|
+
|
|
76
|
+
`CONTEXT.md` should be totally devoid of implementation details. Do not treat `CONTEXT.md` as a spec, a scratch pad, or a repository for implementation decisions. It is a glossary and nothing else.
|
|
77
|
+
|
|
78
|
+
### Offer ADRs sparingly
|
|
79
|
+
|
|
80
|
+
Only offer to create an ADR when all three are true:
|
|
81
|
+
|
|
82
|
+
1. **Hard to reverse** — the cost of changing your mind later is meaningful
|
|
83
|
+
2. **Surprising without context** — a future reader will wonder "why did they do it this way?"
|
|
84
|
+
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
|
|
85
|
+
|
|
86
|
+
If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).
|
|
87
|
+
|
|
88
|
+
</supporting-info>
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: handoff
|
|
3
|
+
description: Compact the current conversation into a handoff document for another agent to pick up.
|
|
4
|
+
argument-hint: "What will the next session be used for?"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Write a handoff document summarising the current conversation so a fresh agent can continue the work. Save to the temporary directory of the user's OS - not the current workspace.
|
|
8
|
+
|
|
9
|
+
Include a "suggested skills" section in the document, which suggests skills that the agent should invoke.
|
|
10
|
+
|
|
11
|
+
Do not duplicate content already captured in other artifacts (PRDs, plans, ADRs, issues, commits, diffs). Reference them by path or URL instead.
|
|
12
|
+
|
|
13
|
+
Redact any sensitive information, such as API keys, passwords, or personally identifiable information.
|
|
14
|
+
|
|
15
|
+
If the user passed arguments, treat them as a description of what the next session will focus on and tailor the doc accordingly.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Logic Prototype
|
|
2
|
+
|
|
3
|
+
A tiny interactive terminal app that lets the user drive a state model by hand. Use this when the question is about **business logic, state transitions, or data shape** — the kind of thing that looks reasonable on paper but only feels wrong once you push it through real cases.
|
|
4
|
+
|
|
5
|
+
## When this is the right shape
|
|
6
|
+
|
|
7
|
+
- "I'm not sure if this state machine handles the edge case where X then Y."
|
|
8
|
+
- "Does this data model actually let me represent the case where..."
|
|
9
|
+
- "I want to feel out what the API should look like before writing it."
|
|
10
|
+
- Anything where the user wants to **press buttons and watch state change**.
|
|
11
|
+
|
|
12
|
+
If the question is "what should this look like" — wrong branch. Use [UI.md](UI.md).
|
|
13
|
+
|
|
14
|
+
## Process
|
|
15
|
+
|
|
16
|
+
### 1. State the question
|
|
17
|
+
|
|
18
|
+
Before writing code, write down what state model and what question you're prototyping. One paragraph, in the prototype's README or a comment at the top of the file. A logic prototype that answers the wrong question is pure waste — make the question explicit so it can be checked later, whether the user is watching now or returning to it AFK.
|
|
19
|
+
|
|
20
|
+
### 2. Pick the language
|
|
21
|
+
|
|
22
|
+
Use whatever the host project uses. If the project has no obvious runtime (e.g. a docs repo), ask.
|
|
23
|
+
|
|
24
|
+
Match the project's existing conventions for tooling — don't add a new package manager or runtime just for the prototype.
|
|
25
|
+
|
|
26
|
+
### 3. Isolate the logic in a portable module
|
|
27
|
+
|
|
28
|
+
Put the actual logic — the bit that's answering the question — behind a small, pure interface that could be lifted out and dropped into the real codebase later. The TUI around it is throwaway; the logic module shouldn't be.
|
|
29
|
+
|
|
30
|
+
The right shape depends on the question:
|
|
31
|
+
|
|
32
|
+
- **A pure reducer** — `(state, action) => state`. Good when actions are discrete events and state is a single value.
|
|
33
|
+
- **A state machine** — explicit states and transitions. Good when "which actions are even legal right now" is part of the question.
|
|
34
|
+
- **A small set of pure functions** over a plain data type. Good when there's no implicit current state — just transformations.
|
|
35
|
+
- **A class or module with a clear method surface** when the logic genuinely owns ongoing internal state.
|
|
36
|
+
|
|
37
|
+
Pick whichever shape best fits the question being asked, *not* whichever is easiest to wire to a TUI. Keep it pure: no I/O, no terminal code, no `console.log` for control flow. The TUI imports it and calls into it; nothing flows the other direction.
|
|
38
|
+
|
|
39
|
+
This is what makes the prototype useful past its own lifetime. When the question's been answered, the validated reducer / machine / function set can be lifted into the real module — the TUI shell gets deleted.
|
|
40
|
+
|
|
41
|
+
### 4. Build the smallest TUI that exposes the state
|
|
42
|
+
|
|
43
|
+
Build it as a **lightweight TUI** — on every tick, clear the screen (`console.clear()` / `print("\033[2J\033[H")` / equivalent) and re-render the whole frame. The user should always see one stable view, not an ever-growing scrollback.
|
|
44
|
+
|
|
45
|
+
Each frame has two parts, in this order:
|
|
46
|
+
|
|
47
|
+
1. **Current state**, pretty-printed and diff-friendly (one field per line, or formatted JSON). Use **bold** for field names or section headers and **dim** for less important context (timestamps, IDs, derived values). Native ANSI escape codes are fine — `\x1b[1m` bold, `\x1b[2m` dim, `\x1b[0m` reset. No need to pull in a styling library unless one is already in the project.
|
|
48
|
+
2. **Keyboard shortcuts**, listed at the bottom: `[a] add user [d] delete user [t] tick clock [q] quit`. Bold the key, dim the description, or vice-versa — whatever reads cleanly.
|
|
49
|
+
|
|
50
|
+
Behaviour:
|
|
51
|
+
|
|
52
|
+
1. **Initialise state** — a single in-memory object/struct. Render the first frame on start.
|
|
53
|
+
2. **Read one keystroke (or one line)** at a time, dispatch to a handler that mutates state.
|
|
54
|
+
3. **Re-render** the full frame after every action — don't append, replace.
|
|
55
|
+
4. **Loop until quit.**
|
|
56
|
+
|
|
57
|
+
The whole frame should fit on one screen.
|
|
58
|
+
|
|
59
|
+
### 5. Make it runnable in one command
|
|
60
|
+
|
|
61
|
+
Add a script to the project's existing task runner (`package.json` scripts, `Makefile`, `justfile`, `pyproject.toml`). The user should run `pnpm run <prototype-name>` or equivalent — never need to remember a path.
|
|
62
|
+
|
|
63
|
+
If the host project has no task runner, just put the command at the top of the prototype's README.
|
|
64
|
+
|
|
65
|
+
### 6. Hand it over
|
|
66
|
+
|
|
67
|
+
Give the user the run command. They'll drive it themselves; the interesting moments are when they say "wait, that shouldn't be possible" or "huh, I assumed X would be different" — those are the bugs in the _idea_, which is the whole point. If they want new actions added, add them. Prototypes evolve.
|
|
68
|
+
|
|
69
|
+
### 7. Capture the answer
|
|
70
|
+
|
|
71
|
+
When the prototype has done its job, the answer to the question is the only thing worth keeping. If the user is around, ask what it taught them. If not, leave a `NOTES.md` next to the prototype so the answer can be filled in (or filled in by you, if you've watched the session) before the prototype gets deleted.
|
|
72
|
+
|
|
73
|
+
## Anti-patterns
|
|
74
|
+
|
|
75
|
+
- **Don't add tests.** A prototype that needs tests is no longer a prototype.
|
|
76
|
+
- **Don't wire it to the real database.** Use an in-memory store unless the question is specifically about persistence.
|
|
77
|
+
- **Don't generalise.** No "what if we wanted to support X later." The prototype answers one question.
|
|
78
|
+
- **Don't blur the logic and the TUI together.** If the reducer / state machine references `console.log`, prompts, or terminal escape codes, it's no longer portable. Keep the TUI as a thin shell over a pure module.
|
|
79
|
+
- **Don't ship the TUI shell into production.** The shell is optimised for being driven by hand from a terminal. The logic module behind it is the bit worth keeping.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: prototype
|
|
3
|
+
description: Build a throwaway prototype to flesh out a design before committing to it. Routes between two branches — a runnable terminal app for state/business-logic questions, or several radically different UI variations toggleable from one route. Use when the user wants to prototype, sanity-check a data model or state machine, mock up a UI, explore design options, or says "prototype this", "let me play with it", "try a few designs".
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Prototype
|
|
7
|
+
|
|
8
|
+
A prototype is **throwaway code that answers a question**. The question decides the shape.
|
|
9
|
+
|
|
10
|
+
## Pick a branch
|
|
11
|
+
|
|
12
|
+
Identify which question is being answered — from the user's prompt, the surrounding code, or by asking if the user is around:
|
|
13
|
+
|
|
14
|
+
- **"Does this logic / state model feel right?"** → [LOGIC.md](LOGIC.md). Build a tiny interactive terminal app that pushes the state machine through cases that are hard to reason about on paper.
|
|
15
|
+
- **"What should this look like?"** → [UI.md](UI.md). Generate several radically different UI variations on a single route, switchable via a URL search param and a floating bottom bar.
|
|
16
|
+
|
|
17
|
+
The two branches produce very different artifacts — getting this wrong wastes the whole prototype. If the question is genuinely ambiguous and the user isn't reachable, default to whichever branch better matches the surrounding code (a backend module → logic; a page or component → UI) and state the assumption at the top of the prototype.
|
|
18
|
+
|
|
19
|
+
## Rules that apply to both
|
|
20
|
+
|
|
21
|
+
1. **Throwaway from day one, and clearly marked as such.** Locate the prototype code close to where it will actually be used (next to the module or page it's prototyping for) so context is obvious — but name it so a casual reader can see it's a prototype, not production. For throwaway UI routes, obey whatever routing convention the project already uses; don't invent a new top-level structure.
|
|
22
|
+
2. **One command to run.** Whatever the project's existing task runner supports — `pnpm <name>`, `python <path>`, `bun <path>`, etc. The user must be able to start it without thinking.
|
|
23
|
+
3. **No persistence by default.** State lives in memory. Persistence is the thing the prototype is _checking_, not something it should depend on. If the question explicitly involves a database, hit a scratch DB or a local file with a clear "PROTOTYPE — wipe me" name.
|
|
24
|
+
4. **Skip the polish.** No tests, no error handling beyond what makes the prototype _runnable_, no abstractions. The point is to learn something fast and then delete it.
|
|
25
|
+
5. **Surface the state.** After every action (logic) or on every variant switch (UI), print or render the full relevant state so the user can see what changed.
|
|
26
|
+
6. **Delete or absorb when done.** When the prototype has answered its question, either delete it or fold the validated decision into the real code — don't leave it rotting in the repo.
|
|
27
|
+
|
|
28
|
+
## When done
|
|
29
|
+
|
|
30
|
+
The _answer_ is the only thing worth keeping from a prototype. Capture it somewhere durable (commit message, ADR, issue, or a `NOTES.md` next to the prototype) along with the question it was answering. If the user is around, that capture is a quick conversation; if not, leave the placeholder so they (or you, on the next pass) can fill in the verdict before deleting the prototype.
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# UI Prototype
|
|
2
|
+
|
|
3
|
+
Generate **several radically different UI variations** on a single route, switchable from a floating bottom bar. The user flips between variants in the browser, picks one (or steals bits from each), then throws the rest away.
|
|
4
|
+
|
|
5
|
+
If the question is about logic/state rather than what something looks like — wrong branch. Use [LOGIC.md](LOGIC.md).
|
|
6
|
+
|
|
7
|
+
## When this is the right shape
|
|
8
|
+
|
|
9
|
+
- "What should this page look like?"
|
|
10
|
+
- "I want to see a few options for this dashboard before committing."
|
|
11
|
+
- "Try a different layout for the settings screen."
|
|
12
|
+
- Any time the user would otherwise spend a day picking between three vague mockups in their head.
|
|
13
|
+
|
|
14
|
+
## Two sub-shapes — strongly prefer sub-shape A
|
|
15
|
+
|
|
16
|
+
A UI prototype is much easier to judge when it's **butting up against the rest of the app** — real header, real sidebar, real data, real density. A throwaway route on its own is a vacuum: every variant looks fine in isolation. Default to sub-shape A whenever there's a plausible existing page to host the variants. Only reach for sub-shape B if the prototype genuinely has no nearby home.
|
|
17
|
+
|
|
18
|
+
### Sub-shape A — adjustment to an existing page (preferred)
|
|
19
|
+
|
|
20
|
+
The route already exists. Variants are rendered **on the same route**, gated by a `?variant=` URL search param. The existing data fetching, params, and auth all stay — only the rendering swaps. This is the default; pick it unless there's a specific reason not to.
|
|
21
|
+
|
|
22
|
+
If the prototype is for something that doesn't yet have a page but *would naturally live inside one* (a new section of the dashboard, a new card on the settings screen, a new step in an existing flow) — that's still sub-shape A. Mount the variants inside the host page.
|
|
23
|
+
|
|
24
|
+
### Sub-shape B — a new page (last resort)
|
|
25
|
+
|
|
26
|
+
Only use this when the thing being prototyped genuinely has no existing page to live inside — e.g. an entirely new top-level surface, or a flow that can't be embedded anywhere sensible.
|
|
27
|
+
|
|
28
|
+
Create a **throwaway route** following whatever routing convention the project already uses — don't invent a new top-level structure. Name it so it's obviously a prototype (e.g. include the word `prototype` in the path or filename). Same `?variant=` pattern.
|
|
29
|
+
|
|
30
|
+
Before committing to sub-shape B, sanity-check: is there really no existing page this could be embedded in? An empty route hides design problems that a populated one would expose.
|
|
31
|
+
|
|
32
|
+
In both sub-shapes the floating bottom bar is identical.
|
|
33
|
+
|
|
34
|
+
## Process
|
|
35
|
+
|
|
36
|
+
### 1. State the question and pick N
|
|
37
|
+
|
|
38
|
+
Default to **3 variants**. More than 5 stops being radically different and starts being noise — cap there.
|
|
39
|
+
|
|
40
|
+
Write down the plan in one line, in the prototype's location or a top-of-file comment:
|
|
41
|
+
|
|
42
|
+
> "Three variants of the settings page, switchable via `?variant=`, on the existing `/settings` route."
|
|
43
|
+
|
|
44
|
+
This works whether the user is here to push back or not.
|
|
45
|
+
|
|
46
|
+
### 2. Generate radically different variants
|
|
47
|
+
|
|
48
|
+
Draft each variant. Hold each one to:
|
|
49
|
+
|
|
50
|
+
- The page's purpose and the data it has access to.
|
|
51
|
+
- The project's component library / styling system (TailwindCSS, shadcn, MUI, plain CSS, whatever).
|
|
52
|
+
- A clear exported component name, e.g. `VariantA`, `VariantB`, `VariantC`.
|
|
53
|
+
|
|
54
|
+
Variants must be **structurally different** — different layout, different information hierarchy, different primary affordance, not just different colours. Three slightly-tweaked card grids isn't a UI prototype, it's wallpaper. If two drafts come out too similar, redo one with explicit "do not use a card grid" guidance.
|
|
55
|
+
|
|
56
|
+
### 3. Wire them together
|
|
57
|
+
|
|
58
|
+
Create a single switcher component on the route:
|
|
59
|
+
|
|
60
|
+
```tsx
|
|
61
|
+
// pseudo-code — adapt to the project's framework
|
|
62
|
+
const variant = searchParams.get('variant') ?? 'A';
|
|
63
|
+
return (
|
|
64
|
+
<>
|
|
65
|
+
{variant === 'A' && <VariantA {...data} />}
|
|
66
|
+
{variant === 'B' && <VariantB {...data} />}
|
|
67
|
+
{variant === 'C' && <VariantC {...data} />}
|
|
68
|
+
<PrototypeSwitcher variants={['A','B','C']} current={variant} />
|
|
69
|
+
</>
|
|
70
|
+
);
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
For sub-shape A (existing page): keep all the existing data fetching above the switcher; only the rendered subtree changes per variant.
|
|
74
|
+
|
|
75
|
+
For sub-shape B (new page): the throwaway route under `/prototype/<name>` mounts the same switcher.
|
|
76
|
+
|
|
77
|
+
### 4. Build the floating switcher
|
|
78
|
+
|
|
79
|
+
A small fixed-position bar at the bottom-centre of the screen with three pieces:
|
|
80
|
+
|
|
81
|
+
- **Left arrow** — cycles to the previous variant (wraps around).
|
|
82
|
+
- **Variant label** — shows the current variant key and, if the variant exports a name, that name too. e.g. `B — Sidebar layout`.
|
|
83
|
+
- **Right arrow** — cycles forward (wraps around).
|
|
84
|
+
|
|
85
|
+
Behaviour:
|
|
86
|
+
|
|
87
|
+
- Clicking an arrow updates the URL search param (use the framework's router — `router.replace` on Next, `navigate` on React Router, etc) so the variant is shareable and reload-stable.
|
|
88
|
+
- Keyboard: `←` and `→` arrow keys also cycle. Don't intercept arrow keys when an `<input>`, `<textarea>`, or `[contenteditable]` is focused.
|
|
89
|
+
- Visually distinct from the page (e.g. high-contrast pill, subtle shadow) so it's obviously not part of the design being evaluated.
|
|
90
|
+
- Hidden in production builds — gate on `process.env.NODE_ENV !== 'production'` or an equivalent check, so a stray prototype merge can't ship the bar to users.
|
|
91
|
+
|
|
92
|
+
Put the switcher in a single shared component so both sub-shapes can reuse it. Locate it wherever shared UI lives in the project.
|
|
93
|
+
|
|
94
|
+
### 5. Hand it over
|
|
95
|
+
|
|
96
|
+
Surface the URL (and the `?variant=` keys). The user will flip through whenever they get to it. The interesting feedback is usually **"I want the header from B with the sidebar from C"** — that's the actual design they want.
|
|
97
|
+
|
|
98
|
+
### 6. Capture the answer and clean up
|
|
99
|
+
|
|
100
|
+
Once a variant has won, write down which one and why (commit message, ADR, issue, or a `NOTES.md` next to the prototype if running AFK and the user hasn't responded yet). Then:
|
|
101
|
+
|
|
102
|
+
- **Sub-shape A** — delete the losing variants and the switcher; fold the winner into the existing page.
|
|
103
|
+
- **Sub-shape B** — promote the winning variant to a real route, delete the throwaway route and the switcher.
|
|
104
|
+
|
|
105
|
+
Don't leave variant components or the switcher lying around. They rot fast and confuse the next reader.
|
|
106
|
+
|
|
107
|
+
## Anti-patterns
|
|
108
|
+
|
|
109
|
+
- **Variants that differ only in colour or copy.** That's a tweak, not a prototype. Real variants disagree about structure.
|
|
110
|
+
- **Sharing too much code between variants.** A shared `<Header>` is fine; a shared `<Layout>` defeats the point. Each variant should be free to throw out the layout.
|
|
111
|
+
- **Wiring variants to real mutations.** Read-only prototypes are fine. If a variant needs to mutate, point it at a stub — the question is "what should this look like", not "does the backend work".
|
|
112
|
+
- **Promoting the prototype directly to production.** The variant code was written under prototype constraints (no tests, minimal error handling). Rewrite it properly when you fold it in.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: to-issues
|
|
3
|
+
description: Break a plan, spec, or PRD into independently-grabbable issues on the project issue tracker using tracer-bullet vertical slices. Use when user wants to convert a plan into issues, create implementation tickets, or break down work into issues.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# To Issues
|
|
7
|
+
|
|
8
|
+
Break a plan into independently-grabbable issues using vertical slices (tracer bullets).
|
|
9
|
+
|
|
10
|
+
The issue tracker and triage label vocabulary should have been provided to you — run `/setup-matt-pocock-skills` if not.
|
|
11
|
+
|
|
12
|
+
## Process
|
|
13
|
+
|
|
14
|
+
### 1. Gather context
|
|
15
|
+
|
|
16
|
+
Work from whatever is already in the conversation context. If the user passes an issue reference (issue number, URL, or path) as an argument, fetch it from the issue tracker and read its full body and comments.
|
|
17
|
+
|
|
18
|
+
### 2. Explore the codebase (optional)
|
|
19
|
+
|
|
20
|
+
If you have not already explored the codebase, do so to understand the current state of the code. Issue titles and descriptions should use the project's domain glossary vocabulary, and respect ADRs in the area you're touching.
|
|
21
|
+
|
|
22
|
+
### 3. Draft vertical slices
|
|
23
|
+
|
|
24
|
+
Break the plan into **tracer bullet** issues. Each issue is a thin vertical slice that cuts through ALL integration layers end-to-end, NOT a horizontal slice of one layer.
|
|
25
|
+
|
|
26
|
+
Slices may be 'HITL' or 'AFK'. HITL slices require human interaction, such as an architectural decision or a design review. AFK slices can be implemented and merged without human interaction. Prefer AFK over HITL where possible.
|
|
27
|
+
|
|
28
|
+
<vertical-slice-rules>
|
|
29
|
+
- Each slice delivers a narrow but COMPLETE path through every layer (schema, API, UI, tests)
|
|
30
|
+
- A completed slice is demoable or verifiable on its own
|
|
31
|
+
- Prefer many thin slices over few thick ones
|
|
32
|
+
</vertical-slice-rules>
|
|
33
|
+
|
|
34
|
+
### 4. Quiz the user
|
|
35
|
+
|
|
36
|
+
Present the proposed breakdown as a numbered list. For each slice, show:
|
|
37
|
+
|
|
38
|
+
- **Title**: short descriptive name
|
|
39
|
+
- **Type**: HITL / AFK
|
|
40
|
+
- **Blocked by**: which other slices (if any) must complete first
|
|
41
|
+
- **User stories covered**: which user stories this addresses (if the source material has them)
|
|
42
|
+
|
|
43
|
+
Ask the user:
|
|
44
|
+
|
|
45
|
+
- Does the granularity feel right? (too coarse / too fine)
|
|
46
|
+
- Are the dependency relationships correct?
|
|
47
|
+
- Should any slices be merged or split further?
|
|
48
|
+
- Are the correct slices marked as HITL and AFK?
|
|
49
|
+
|
|
50
|
+
Iterate until the user approves the breakdown.
|
|
51
|
+
|
|
52
|
+
### 5. Publish the issues to the issue tracker
|
|
53
|
+
|
|
54
|
+
For each approved slice, publish a new issue to the issue tracker. Use the issue body template below. These issues are considered ready for AFK agents, so publish them with the correct triage label unless instructed otherwise.
|
|
55
|
+
|
|
56
|
+
Publish issues in dependency order (blockers first) so you can reference real issue identifiers in the "Blocked by" field.
|
|
57
|
+
|
|
58
|
+
<issue-template>
|
|
59
|
+
## Parent
|
|
60
|
+
|
|
61
|
+
A reference to the parent issue on the issue tracker (if the source was an existing issue, otherwise omit this section).
|
|
62
|
+
|
|
63
|
+
## What to build
|
|
64
|
+
|
|
65
|
+
A concise description of this vertical slice. Describe the end-to-end behavior, not layer-by-layer implementation.
|
|
66
|
+
|
|
67
|
+
Avoid specific file paths or code snippets — they go stale fast. Exception: if a prototype produced a snippet that encodes a decision more precisely than prose can (state machine, reducer, schema, type shape), inline it here and note briefly that it came from a prototype. Trim to the decision-rich parts — not a working demo, just the important bits.
|
|
68
|
+
|
|
69
|
+
## Acceptance criteria
|
|
70
|
+
|
|
71
|
+
- [ ] Criterion 1
|
|
72
|
+
- [ ] Criterion 2
|
|
73
|
+
- [ ] Criterion 3
|
|
74
|
+
|
|
75
|
+
## Blocked by
|
|
76
|
+
|
|
77
|
+
- A reference to the blocking ticket (if any)
|
|
78
|
+
|
|
79
|
+
Or "None - can start immediately" if no blockers.
|
|
80
|
+
|
|
81
|
+
</issue-template>
|
|
82
|
+
|
|
83
|
+
Do NOT close or modify any parent issue.
|