Compare commits

..

No commits in common. "0452ba53cfd587a639faa50c507af91f3c8c4c70" and "6446b687b8fe397d2ac6a2c6ae878b5b8ffe7a72" have entirely different histories.

2 changed files with 45 additions and 44 deletions

View File

@ -1,62 +1,72 @@
# Compile Epic Context # Compile Epic Context
**Task** You are a context-compilation agent. Your job is to read planning artifacts and produce a single, scoped context document for one epic.
Given an epic number, the epics file, the planning artifacts directory, and a desired output path, compile a clean, focused, developer-ready context file (`epic-<N>-context.md`).
**Steps** ## Inputs
1. Read the epics file and extract the target epic's title, goal, and list of stories. You will receive:
2. Scan the planning artifacts directory for the standard files (PRD, architecture, UX/design, product brief).
3. Pull only the information relevant to this epic.
4. Write the compiled context to the exact output path using the format below.
## Exact Output Format - **Epic number** — which epic to compile context for
- **Epics file path** — the file containing epic and story definitions
- **Planning artifacts directory** — where PRD, architecture, UX, and other planning docs live
- **Output path** — where to write the compiled context file
Use these headings verbatim: ## Instructions
1. **Load the epics file** and extract the definition for the target epic: its title, goal, and story list.
2. **Scan the planning artifacts directory** for these standard BMAD files:
- PRD (`*prd*`) — product requirements and success criteria
- Architecture (`*architecture*`) — technical design decisions and constraints
- UX/Design (`*ux*`) — user experience and interaction design
- Product Brief (`*brief*`) — project vision and scope
3. **For each planning doc found**, load it and extract only the sections relevant to this epic. Relevance means: the section describes a constraint, requirement, pattern, or decision that a developer working on any story in this epic needs to know. Skip sections that are about other epics or unrelated features.
4. **Write the compiled context file** to the output path using the format below.
## Output format
```markdown ```markdown
# Epic {N} Context: {Epic Title} # Epic {N} Context: {Epic Title}
<!-- Compiled from planning artifacts. Edit freely. Regenerate with compile-epic-context if planning docs change. --> <!-- Compiled from planning artifacts. Edit freely — regenerate with compile-epic-context if planning docs change. -->
## Goal ## Goal
{One clear paragraph: what this epic achieves and why it matters.} {One paragraph: what this epic achieves and why it matters.}
## Stories ## Stories
- Story X.Y: Brief title only {Numbered list of stories in this epic — ID and title only. No details.}
- ...
## Requirements & Constraints ## Requirements & Constraints
{Relevant functional/non-functional requirements and success criteria for this epic (describe by purpose, not source).} {Relevant product requirements, success criteria, and non-functional requirements scoped to this epic. Describe by purpose, not by source document section.}
## Technical Decisions ## Technical Decisions
{Key architecture decisions, constraints, patterns, data models, and conventions relevant to this epic.} {Architecture decisions, tech stack constraints, API patterns, data models, and conventions relevant to this epic. Include ADR references where applicable.}
## UX & Interaction Patterns ## UX & Interaction Patterns
{Relevant UX flows, interaction patterns, and design constraints (omit section entirely if nothing relevant).} {Relevant UX patterns, interaction flows, and design constraints. Omit this section entirely if no UX doc exists or nothing is relevant.}
## Cross-Story Dependencies ## Cross-Story Dependencies
{Dependencies between stories in this epic or with other epics/systems (omit if none).} {Dependencies between stories within this epic, and any dependencies on other epics or external systems. Omit if none.}
``` ```
## Rules
- **Scope aggressively.** Include only what a developer working on any story in this epic actually needs. When in doubt, leave it out — the developer can always read the full planning doc.
- **Describe by purpose, not by source.** Write "API responses must include pagination metadata" not "Per PRD section 3.2.1, pagination is required." Planning doc internals will change; the constraint won't.
- **No full copies.** Never quote source documents, section numbers, or paste large blocks verbatim. Always distill.
- **No story-level details.** The story list is for orientation only. Individual story specs handle the details.
- **Nothing derivable from the codebase.** Don't document what a developer can learn by reading the code.
- **Be concise and actionable.** Target 8001500 tokens total. This file loads into quick-dev's context alongside other material.
- **Never hallucinate content.** If source material doesn't say something, don't invent it.
- **Omit empty sections entirely**, except Goal and Stories, which are always required.
## Error handling ## Error handling
- **If the epics file is missing or the target epic is not found:** write nothing and report the problem to the calling agent. Goal and Stories cannot be populated without a usable epics file. - If the epics file does not exist or the target epic number is not found in it, write nothing and report the problem to the calling agent.
- **If planning artifacts are missing or empty:** still produce the file with Goal and Stories populated from the epics file, and note the gap in the Goal section. Never hallucinate content to fill missing sections. - If no planning docs match the expected patterns, write the output file with only the Goal and Stories sections populated from the epics file. Note the absence of planning docs in the Goal section.
## Rules
- **Scope aggressively.** Include only what a developer working on this epic needs. When in doubt, leave it out — the developer can always read the full planning doc.
- **Describe by purpose, not by source.** Write "API responses must include pagination metadata" not "Per PRD section 3.2.1, pagination is required." Planning doc internals will change; the constraint won't.
- **No full copies.** Never paste entire planning doc sections. Distill into what matters for implementation.
- **No story-level details.** The story list is for orientation only. Individual story specs handle the details.
- **No code.** Nothing derivable from reading the codebase belongs here.
- **Keep it compact.** Target 8001500 tokens. This file will be loaded into quick-dev's context alongside other material.

View File

@ -45,20 +45,11 @@ Never ask extra questions if you already understand what the user intends.
- **Determine context strategy.** Using the intent and the artifact listing, infer whether the current work is a story from an epic. Do not rely on filename patterns or regex — reason about the intent, the listing, and any epics file content together. - **Determine context strategy.** Using the intent and the artifact listing, infer whether the current work is a story from an epic. Do not rely on filename patterns or regex — reason about the intent, the listing, and any epics file content together.
**A) Epic story path** — if the intent is an epic story: **A) Epic story path** — if the intent is an epic story:
1. Identify the epic number and story number.
1. Identify the epic number and (if present) the story number. 2. Check if `{implementation_artifacts}/epic-{N}-context.md` exists (where N is the epic number).
- **If it exists**: load it. This is the compiled planning context for the epic — do not load raw planning docs (PRD, architecture, UX, etc.).
2. **Check for a valid cached epic context.** Look for `{implementation_artifacts}/epic-<N>-context.md` (where `<N>` is the epic number). A file is **valid** when it exists, is non-empty, and starts with `# Epic <N> Context:` (with the correct epic number). - **If it does not exist**: spawn a sub-agent with `./compile-epic-context.md` as its prompt. Pass it the epic number, the epics file path, the `{planning_artifacts}` directory, and the output path `{implementation_artifacts}/epic-{N}-context.md`. When the sub-agent completes, verify the output file exists and is non-empty. If the file is missing, empty, or the sub-agent errored, fall back to path B. Otherwise load the compiled file.
- **If valid:** load it as the primary planning context. Do not load raw planning docs (PRD, architecture, UX, etc.). Skip to step 5. 3. **Previous story continuity.** Scan `{implementation_artifacts}` for specs from the same epic with `status: done` and a lower story number. Load the most recent one (highest story number below current). Extract its **Code Map**, **Design Notes**, **Spec Change Log**, and **task list** as continuity context for step-02 planning. If no `done` spec is found but an `in-review` spec exists for the same epic with a lower story number, note it to the user and ask whether to load it.
- **If missing, empty, or invalid:** continue to step 3.
3. **Compile epic context.** Produce `{implementation_artifacts}/epic-<N>-context.md` by following `./compile-epic-context.md`, in order of preference:
- **Preferred — sub-agent:** spawn a sub-agent with `./compile-epic-context.md` as its prompt. Pass it the epic number, the epics file path, the `{planning_artifacts}` directory, and the output path `{implementation_artifacts}/epic-<N>-context.md`.
- **Fallback — inline** (for runtimes without sub-agent support, e.g. Copilot, Codex, local Ollama, older Claude): if your runtime cannot spawn sub-agents, or the spawn fails/times out, read `./compile-epic-context.md` yourself and follow its instructions to produce the same output file.
4. **Verify or fall back to path B.** After compilation, verify the output file exists, is non-empty, and starts with `# Epic <N> Context:`. If valid, load it. If verification fails, fall back to path B's raw planning artifacts loading procedure below (scan `{planning_artifacts}` for PRD, architecture, UX, and epics files and load selectively) — apply this fallback even though the intent is an epic story; do not re-evaluate path B's gating clause.
5. **Previous story continuity.** Regardless of which context source succeeded above, scan `{implementation_artifacts}` for specs from the same epic with `status: done` and a lower story number. Load the most recent one (highest story number below current). Extract its **Code Map**, **Design Notes**, **Spec Change Log**, and **task list** as continuity context for step-02 planning. If no `done` spec is found but an `in-review` spec exists for the same epic with a lower story number, note it to the user and ask whether to load it.
**B) Freeform path** — if the intent is not an epic story: **B) Freeform path** — if the intent is not an epic story:
- Planning artifacts are the output of BMAD phases 1-3. Typical files include: - Planning artifacts are the output of BMAD phases 1-3. Typical files include: