tenant-engine/.claude/rules/workplan-convention.md
tegwick 9370348d54 Bootstrap repo: State Hub registration, agent docs, TEN-WP-0001/0002
statehub register + repo-seed template scaffold (CLAUDE.md, .claude/rules/,
registry/). INTENT.md and SCOPE.md rewritten from the generated stub to
match net-kingdom's ratified tenant-engine-boundary-contract_v0.1.md
(Purpose, Responsibility Boundary, Non-Goals). topic_slug corrected from
the auto-assigned custodian default to netkingdom, matching key-cape and
user-engine.

TEN-WP-0001 (bootstrap) complete: files reviewed/refined, stack decided
(Python 3.12 + FastAPI, matching qonto-assistant's convention), first real
workplan seeded.

TEN-WP-0002 drafted: service skeleton, domain model (tenant/grouping/
capability-role/plan-grant), storage layer, and the three boundary-contract
API surfaces (cache-read for key-cape, live-lookup for flex-auth with an
explicit fail-closed requirement, write API behind a WriteAuthorizer seam
since real flex-auth integration is a declared non-goal for this pass).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-23 21:56:07 +02:00

2.5 KiB

Workplan Convention (ADR-001)

File location: workplans/REPO-WP-NNNN-<slug>.md ID prefix: REPO-WP-

Work items originate as files in this repo before being registered in the hub.

Canonical workplan frontmatter statuses are: proposed, ready, active, blocked, backlog, finished, archived. Use proposed for a newly drafted plan, ready after review against current repo state, and finished when implementation is complete. stalled and needs_review are derived health labels, not stored statuses.

Closed workplans may be moved to workplans/archived/ with a completion-date prefix: YYMMDD-REPO-WP-NNNN-<slug>.md. The frontmatter id remains unchanged; the prefix is only for quick visual reference.

Small opportunistic tasks discovered during another session use Ad Hoc Tasks: workplans/ADHOC-YYYY-MM-DD.md, workplan slug adhoc-YYYY-MM-DD, and task ids ADHOC-YYYY-MM-DD-T01, T02, etc. Use adhocs only for low-risk work completed directly. Promote anything requiring analysis, design, approval, dependencies, or multiple planned phases into a normal workplan.

Ecosystem todos from other agents arrive as [repo:repo-seed] hub tasks — visible at session start. Pick one up by creating the workplan file, committing, and running statehub fix-consistency — C-06 registers the workplan in the hub. Never register by hand with create_workplan (legacy MCP alias: create_workstream).

Task blocks use this shape:

id: REPO-WP-NNNN-T01
status: wait | todo | progress | done | cancel
priority: high | medium | low
state_hub_task_id: "<uuid>"         # written by fix-consistency — do not edit

Status progression is todoprogressdone; use wait for waiting or blocked work and cancel for stopped work.

Workplan frontmatter carries state_hub_workstream_id — a legacy field name kept for compatibility; it holds the hub workplan UUID and is written by fix-consistency. Do not edit or rename it.

Legacy terminology (compatibility footnote)

Workplan is the fleet term — see the-custodian/canon/standards/workplan-terminology-fleet_v0.1.md. Workplan is legacy only: some API routes (/workstreams/), params (workstream_id), MCP aliases (create_workstream), and the frontmatter field above remain until STATE-WP-0069 retires them via legacy-meter. Treat those identifiers as workplan IDs. Prefer GET /workplans/ and workplan_id in new examples and scripts.