Skip to content

Latest commit

 

History

History
54 lines (45 loc) · 2.54 KB

File metadata and controls

54 lines (45 loc) · 2.54 KB

Agent Guidance

Primary Workflow Contract

Use WORKFLOW.md as the main repository workflow contract. Keep this file as the short operational summary for assistants working here.

Spec-Driven Development

This repository separates durable requirements from time-bounded work packets.

  • Reserve specification/ for long-lived contracts that should survive more than one implementation pass.
  • Do not start specification capture unless the maintainer explicitly asks for it or a stable contract has clearly emerged.
  • Write durable requirements directly under specification/<concern>.md; the whole folder is already scoped to Agent Context Trail.
  • Small direct edits do not always need a plan packet.
  • Create or continue a dated packet under plans/YYYY-MM/DD/<change-id>/ only when the maintainer initiates plan-driven work or confirms a proposed plan before implementation starts.
  • Keep plans/README.md as the layout note, plans/open.md for active work, and plans/closed.md for completed packets.
  • Start each packet with plan.md and keep test.md as the proof surface.
  • Create implementation.md only after implementation work has actually happened.
  • Add survey.md only when the maintainer explicitly requests a survey.
  • When a user-initiated or user-confirmed plan is agreed and when it is validated, assess relevant specification/*.md files for planned behavior that may need durable contract changes, clarifications, or explicit exceptions. Record those as open specification-review points rather than overstating them as failures; suggest any candidate additions to the maintainer for review.
  • When work changes direction, update the packet so plan.md, implementation.md, and test.md still describe the same reality.

Temporary Files

  • Do not leave scratch files, ad-hoc scripts, logs, or captures in the workspace root.
  • Put disposable artifacts under .tmp/, using subfolders when a task needs multiple outputs.
  • Treat .tmp/ as disposable. Nothing the repository depends on should live there permanently.

Repository Discipline

  • Keep this workflow layer free of business-specific assumptions until the runtime structure is intentionally designed.
  • Do not pre-create product folders such as src/ or packages/ as part of workflow bootstrapping alone.
  • Keep generated data, caches, and exported artifacts out of plans/ and specification/.
  • Run the smallest meaningful verification for the change and record the proof.
  • Leave git history operations to the maintainer unless explicitly asked.