Skip to content

plan-authoring.md

Latest commit

 

History

History
60 lines (40 loc) · 1.14 KB

plan-authoring.md

File metadata and controls

60 lines (40 loc) · 1.14 KB

Plan Authoring Guide

Write plans that are easy to approve once, auto-sync into canonical tasks, and execute through warcraft_execute.

Plan structure

# Feature Name

## Discovery
- original request
- constraints
- research findings

## Non-Goals
- explicit exclusions

## Ghost Diffs
- alternatives considered and rejected

## Tasks

### 1. Task Name

**Depends on**: none

**Files:**
- Modify: `path/to/file.ts`
- Test: `path/to/file.test.ts`

**What to do**:
- Step 1: ...
- Step 2: ...

**Must NOT do**:
- Guardrails

**References**:
- `file:line` — why it matters

**Verify**:
- [ ] Run: `bun test path/to/test.ts` -> PASS

Guidance

  • use exact file paths
  • keep dependencies explicit
  • make verification commands concrete
  • write tasks so a worker launched through warcraft_execute can act without guessing
  • assume task sync may happen automatically after approval, so the plan should already be canonical and decomposable at approval time

beadsMode

Plan shape does not change with beadsMode. Only storage backend changes.

Terminology

Describe the current workflow in terms of direct execution and explicit task orchestration.