prole/docs/plans/junie/README.md

3.0 KiB

Junie briefs

Self-contained, single-task briefs for Junie to consume from inside the IntelliJ IDE. Each file is a hand-off — Junie reads the brief cold (no shared chat history), implements the change, and opens an MR.

What lives here vs. ../

The .. parent directory holds architectural plans — multi-section documents covering an initiative's strategy, schema, and component design. They outlive the implementation and become the architectural reference once shipped.

This subdirectory holds work briefs — smaller, more tactical, scoped to a single MR's worth of changes. They reference the master TODO index (../../TODO.md) and contain enough context for Junie to land the change without escalating questions.

Brief shape (convention)

Each brief follows this skeleton:

  1. Why — one or two paragraphs of context, including the trigger event if any (e.g. "the 4/28 14:00 UTC outage").
  2. What changes — concrete file paths, line numbers, before/after where useful. Don't make Junie re-derive the change.
  3. Verification — runnable commands or helm template diffs that confirm the change. Each brief ends with a Definition of done checklist.
  4. Out of scope — explicit fences. The TODO is interconnected; without this section briefs creep.
  5. Commit shape — proposed commit message + structure.

Status tracking

Every brief here corresponds to a numbered item in ../../TODO.md (or has an explicit "doesn't yet exist in TODO" note). When Junie lands a brief:

  1. Move the corresponding item from the TODO ranked queue into the Done section with date + commit ref (or the convention used by the rest of the file).
  2. Don't delete the brief from this directory — it stays as the design record.

Current briefs (as of 2026-05-23, post-commit)

Active (in flight)

File Tracked at Subject
k3d-knoe-auth-pod-deploy.md TODO §"In progress"; parent ../k3d-gke-mirror.md §6 Phase 3 Phase 3 of k3d-mirror-of-GKE: build the knoe-auth image, k3d image import, run as a pod inside the cluster. Pre-merge smoke loop with make k3d-knoe-{deploy,redeploy,undeploy}.

Pending (working-tree only)

No pending working-tree changes as of 2026-05-23.

Shipped

Completed briefs have been moved to docs/completed/. See that directory for the full list of shipped work and design records.

How a session fires off a batch

The driving session (Claude Code, Cowork+Code, or a human) writes the briefs into this directory and points Junie at one or more of them. Junie reads the brief, implements, runs the verification checklist, opens an MR. Each brief is independent — Junie can take them in any order, or in parallel across separate IDE sessions.

The brief is the contract. If something is unclear, the brief is buggy and should be edited before Junie continues.