2.8 KiB
2.8 KiB
Project Driver Template
Use this template to create project.md at the target repository root.
The first agent in a repo should create this file; later agents must read and update it before work.
Project Identity
- Project name:
- Repository root:
- Primary language/runtime:
- Primary package manager:
Tooling Baseline (Global Installs)
Record what is already installed on this machine so later agents do not re-check unnecessarily.
bdinstalled and on PATH: yes/nobborbeadboardinstalled and on PATH: yes/no- Detection commands used (with date):
- Notes on shell/platform quirks (WSL/Windows/macOS/Linux):
BeadBoard/Communication Setup
- Mail delegate command configured:
bd config set mail.delegate "node <abs-path>/skills/beadboard-driver/scripts/bb-mail-shim.mjs"
- Agent identity env var policy:
- Preferred:
BB_AGENT=<agent-id> - Fallback:
BD_ACTOR=<agent-id>
- Preferred:
- Delegate validation status:
node skills/beadboard-driver/scripts/ensure-bb-mail-configured.mjspass/fail
- Session preflight status:
node skills/beadboard-driver/scripts/session-preflight.mjspass/fail
Agent State + Heartbeat Policy
- Agent bead naming convention for this repo:
- Required state transitions (spawning -> running -> working -> stuck/done/stopped):
- Heartbeat cadence during active work (recommended 30-120s):
- Stuck escalation timeout before user ping:
Swarm / Formula Defaults
- Primary epic/swarm pattern used by this repo:
- Formula/proto id(s) commonly used (if any):
- Preferred swarm command flow (
bd swarm validate/create/statusetc.):
Command Baseline
- Install command:
- Build command:
- Typecheck command:
- Lint command:
- Test command:
- Smoke command (optional):
Verification Policy Overrides
- Required gates for this project:
- Known slow gates and timeout guidance:
- Evidence format expected in bead notes:
Scope and Safety
- Forbidden commands/actions for this repo:
- Paths requiring reservation before edits:
- External systems requiring human approval:
- Secret handling guidance:
Coordination Defaults
- Default handoff style:
- Blocker escalation policy:
- ACK expectations for
HANDOFF/BLOCKED: - Reservation conflict policy (
--takeover-stalerules):
Known Workarounds
Document only stable, repeatable workarounds.
-
Trigger:
- Symptom:
- Workaround:
- Verification:
- Owner:
-
Trigger:
- Symptom:
- Workaround:
- Verification:
- Owner:
Session Closeout Checklist
- Bead status/assignee updated
- Verification commands executed and recorded
- Artifacts attached/linked
- Memory review performed
- Follow-up beads created (if needed)
project.mdupdated with any new environment facts
Change Log
- YYYY-MM-DD: Initial
project.mdcreated from template.