Files
suaveplan/openspec/templates/README.md
2026-05-27 23:29:53 +01:00

23 lines
1.5 KiB
Markdown

# OpenSpec change templates
Copy these files when starting a new change. Do **not** author from scratch — every template field exists because skipping it has cost the project a real incident.
## When to use
- New package — copy all three.
- New requirement on an existing package — copy `spec-delta.md`, write a single `## ADDED Requirements` section, and add the `proposal.md` + `tasks.md`.
- Spec-conformance audit (no behavior change) — copy `proposal.md` and use the `*-spec-conformance` pattern; the spec delta is purely additive `**Verified by:**` lines under `## MODIFIED Requirements`.
## Files
- `proposal.md` — why, what, source mapping (mandatory for migrated packages), out-of-scope.
- `tasks.md` — concrete checklist. Every box must reflect work actually done in this change. No retroactive ticking.
- `spec-delta.md` — copy into `specs/<cap>/spec.md`. Every requirement carries a `**Verified by:**` line at authoring time.
## Hard rules
1. Read `../suaveplan/enterprise/<pkg>.md` before opening the templates if the package is migrated. (See AGENTS.md Section 14.)
2. Every requirement in the spec delta has a `**Verified by:**` line. (See AGENTS.md Section 13.)
3. Every requirement that derives from `enterprise/<pkg>.md` cites a line range in `proposal.md` `## Source mapping`. Requirements with no source must be listed in the "no source line" table with a justification.
4. `tasks.md` checkboxes are ticked only when the work is genuinely done.