chore: require files/tests lists in every story implementation plan

pull/21/head
VinPropane 2026-04-04 23:14:48 -04:00
parent 8e421d09c1
commit 018d43b08c
1 changed files with 7 additions and 5 deletions

View File

@ -38,16 +38,18 @@ When the user starts work on a **Jira story** (e.g. issue key `NS-14`, phrases l
- Add **`docs/plans/{JIRA_KEY}-implementation-plan.md`** (example: `docs/plans/NS-14-implementation-plan.md`). Create `docs/plans/` if it does not exist.
- **Commit** the plan on the **story branch** from step 1b when it is ready (at agent discretion per [commit-and-review](commit-and-review.md)); do not put ticketed plan-only work only on `main` while implementation stays on a branch—see [git workflow](git-workflow.md).
**Required sections** in that file:
**Required sections** in that file (do **not** ship a plan that omits any of these):
- Story reference (key, title, link if available)
- Goal, scope, and out-of-scope (from Jira)
- Acceptance criteria checklist (from Jira)
- Technical approach (concise)
- **Files to add** (paths)
- **Files to modify** (paths and one-line rationale each)
- **Tests** — what will be added or changed; if none, say why (e.g. no harness yet, manual verification only)
- Open questions / risks (if any)
- **Files to add****mandatory:** explicit list of new file paths (or state “none” with one line why)
- **Files to modify****mandatory:** explicit list of paths **with a one-line rationale each** (or state “none” with one line why)
- **Tests****mandatory:** explicit list of test files to **add** or **change**, and what each will cover; if truly no automated tests, say why (e.g. no harness yet) and what manual verification replaces them
- Open questions / risks (if none, write “None.”)
These three lists (**files to add**, **files to modify**, **tests**) must **always** be generated during kickoff—they are not optional prose and must not be left implicit inside “Technical approach” only.
## 5. After the plan