@workit-dev/core 0.0.1 → 1.0.0

package/templates/plan-template.md

@@ -0,0 +1,26 @@
+# <Feature> plan
+
+Spec: `docs/<slug>/spec.md` · Goal: <one sentence>
+
+A plan records decisions, not code: per slice the branch, what it touches, its
+acceptance, how it is verified, and what it depends on (workit-shape
+`references/slicing.md`). Independent slices fan out (workit-fanout);
+dependent ones stack (`workit stack plan <bottom> … <top>`).
+
+## Global constraints
+
+- <project-wide requirement, one line each>
+
+---
+
+### S1 <type>/<slug>  (base: main)
+
+Touches: <areas, not line numbers>
+Acceptance:
+- Given <state>, When <action>, Then <observable result>
+Verify: `workit check test`; verify-<app> "<feature>"
+Decisions: <ledger refs or one-line rulings>
+
+| Slice | Branch | Depends on | Status |
+| --- | --- | --- | --- |
+| S1 | <type>/<slug> | — | pending |

package/templates/spec-template.md

@@ -0,0 +1,64 @@
+# Spec: <feature>
+
+**Branch:** `feature/<slug>`
+
+**Change:** ADDED|MODIFIED|REMOVED — <one-sentence intent>. (Small work with
+no durable agreement: `Spec: none (<reason>)`, no file.)
+
+## Context
+
+<!-- Why does this exist? What problem does it solve? 1-3 sentences. -->
+
+## Goals
+
+- <!-- measurable, one per bullet -->
+
+## Non-goals
+
+- <!-- explicitly out of scope -->
+
+## Architecture
+
+<!-- Optional: only when a diagram argues a decision (workit-shape
+     references/diagrams.md); otherwise delete this section. -->
+```mermaid
+flowchart TD
+  A[Start] --> B[Step]
+```
+
+<!-- Optional: a UI choice still open gets an ASCII sketch (workit-shape
+     references/mockups.md). -->
+```text
+┌──────────────┐
+│ Header       │
+└──────────────┘
+```
+
+## Data flow / contracts
+
+<!-- REQUIRED when there is a glossary, scope comparison, or contracts: use markdown tables. -->
+| Term | Meaning |
+| --- | --- |
+| <term> | <meaning> |
+
+## Acceptance criteria
+
+<!-- REQUIRED: enumerable, each verifiable. Numbered CA-01, CA-02, ... -->
+<!-- Requirements use SHALL/MUST (one per bullet, observable, no HOW); each
+     carries at least one GIVEN/WHEN/THEN, including the most-regretted edge. -->
+- CA-01 …
+
+## Review checklist
+
+<!-- Before implementation: intent matches; nothing extra; each requirement
+     testable with an exercising scenario; most-cared case covered;
+     tasks trace to requirements; you would sign if built exactly as written. -->
+- [ ] …
+
+## Decisions
+
+- D-01 …
+
+## Future work
+
+- …

package/templates/workit-contract.md

@@ -0,0 +1,13 @@
+# Workit contract
+
+Workit keeps one accountable lead and one shared task state. Inspect current
+task state before acting; use only the shared operations for task, policy,
+evidence, finding, decision, worker, and state changes. Authority is
+bounded by the requested scope, current revision, caller/session provenance, and
+observed capabilities; delivery is bounded by the workspace autonomy grants
+(`workit grant show`). Never claim host enforcement or evidence that the host
+cannot provide. Preserve unresolved requirements, gaps, and uncertain workers.
+
+Focused methods are loaded only when the resolved policy requires them. A method
+must call the shared operations and must not create a second lifecycle, approval
+chain, or task-state representation.