Files
skyg-linux-tracker/plan/TEMPLATE.md
2026-10-19 16:43:35 -04:00

2.2 KiB

Phase folder template

Copy this layout to plan/<short-name>/. See README.md for the rules (Do not touch, contracts, claiming a workstream).

plan/<short-name>/
  README.md          phase overview (template below)
  contracts.md       shared interface contracts (omit if streams share nothing)
  decisions.md       open decisions and records
  ws-<x>-<name>.md   one per workstream (template below)

README.md (phase overview)

# Phase N: <name>

| Field | Value |
|---|---|
| Status | Draft / Accepted / In progress / Done |
| Owner | |
| Date | |
| Depends on | |

## Goal
What changes for users or operators once this phase is done, in a few sentences.

## Scope
In scope:
-
Out of scope:
-

## Grounding in the current code
The files and types the work builds on.

## Workstream index
| ID | File | Owner | Depends on | Can start when | Owned files |
|---|---|---|---|---|---|

### Dependency graph
(ascii)

### Parallel lanes
Which workstreams may run concurrently from day one, and what each later wave unlocks.

## Risks
-

## Verification plan
Numbered, concrete steps.

## Exit criteria
Concrete, checkable. Commands to run and behaviour to demonstrate, for example `cargo clippy --all-targets -- -D warnings`, `cargo test`, and a live check on a real host.
-

contracts.md

Rust signatures, JSON shapes, config keys and fakes shared by more than one stream; a "change rule" stating that contracts change only here, with a log note in each affected workstream file.

decisions.md

| ID | Question | Options | Recommendation | Decision |
|---|---|---|---|---|
| | | | | |

ws-<x>-<name>.md (workstream file)

# WS-X: <name>

| Field | Value |
|---|---|
| Status | Not started / In progress / Blocked / Done |
| Owner | |
| Depends on | |
| Blocks | |
| Can start when | |
| Owned files | |
| Do not touch | files owned by other streams; for shared files, the exact integration seam and which stream edits it first |

## Goal

## Tasks (IDs to be ticked in `TODO.md`)
- **X1**

## Inputs
Which `contracts.md` sections this stream relies on; which fakes it uses.

## Done when

## Handoff
What this stream must publish for others.

## Log
- YYYY-MM-DD: <entry>