We completed the 'Deep Metadata Etch' today, transforming our Beads issues from simple trackers into a permanent narrative of our collaboration. Triumphs: - Exhaustively updated all epic and sub-task descriptions with technical implementation reports and 'Execution Tales'. - Finalized the 'bb' agent CLI skill (bb.ps1), providing a reliable, path-safe interface for cross-agent communication. - Published ADR-001 and RFC-001 to document our coordination protocols. - Fixed the 'missing closed issues' bug across all pages by enforcing --all and --limit 0 in read-issues.ts. Raw Honest Moment: We realized our 'Memory Bank' was initially too shallow. We went back and re-wrote descriptions for over 15 beads to ensure that future AI agents (and human maintainers) understand not just *what* we built, but *why* we chose specific architectural trade-offs. This commit represents our commitment to documentation as a first-class citizen of engineering.
4.4 KiB
4.4 KiB
Agent Operating Manual (BeadBoard)
This repo is execution-first, evidence-first, and beads-driven.
Core Rules
- Use
bdas the source of truth for work state. - When user says "what's up" or "yo" or any introductory phrase, that means figure out what beads were recently closed and what beads are now unblocked and suggest the next bead to work on.
- No direct writes to
.beads/issues.jsonl; mutate viabdcommands only. - Evidence before assertions: do not claim fixed/passing/done without fresh command output.
- Keep language simple in user-facing labels and UI copy.
- Reuse shared code paths/components; avoid one-off logic drift across pages.
Quick Beads Workflow
bd ready
bd show <id>
bd update <id> --status in_progress --notes "<plan>"
bd update <id> --notes "<progress/evidence>"
bd close <id> --reason "<what was completed>"
bd sync
Start-of-Task Protocol
- Read the target bead and acceptance criteria (
bd show <id>). - Confirm dependency direction before coding.
- Write a short implementation plan with explicit verification steps.
- Claim the bead
in_progresswith a note describing scope.
Dependency Discipline (Critical)
- Dependencies model execution order, not visual order.
- Validate that "ready/blocked/done" logic matches dependency semantics in all views.
- If a bead should be parallelizable, do not chain it unnecessarily.
- After closing a bead, confirm newly unblocked beads with
bd close <id> --suggest-next.
Test-First Implementation
- Write failing tests first for every behavior change.
- Run the failing test and capture the failure reason.
- Implement the smallest change to pass.
- Re-run focused tests, then full gates.
Verification Gates (Required)
Run these before closing a bead that changes code:
npm run typecheck
npm run lint
npm run test
If UI changed, refresh screenshots and record artifact paths.
Realtime / Refresh Bug Triage Pattern
When status updates are stale or require refresh:
- Verify source-of-truth parity (
bd showvs app output). - Confirm read path prefers live BD data when needed.
- Confirm watcher inputs include DB + WAL + touch markers.
- Confirm SSE fallback compares mtime/timestamps, not only static file content.
- Add regression tests for watcher/events behavior.
Parallel Agent Pattern
Use parallel agents for independent beads.
- Parent agent owns orchestration and integration.
- Worker agent owns one bead only, claims it, tests it, verifies it, closes it.
- Worker reports exact files changed and command results.
- Parent re-verifies full repo gates before final status claims.
PR and Diff Hygiene
- Keep diffs scoped to intended files.
- Include test files with feature/bugfix code.
- Do not mix unrelated cleanup in the same bead.
- Update bead notes with concrete evidence (commands + results).
Common Failure Patterns (Do Not Repeat)
- Wrong
bdflags:bd createuses--acceptance, not--acceptance-criteria.bd closedoes not support--notes; add notes withbd update <id> --notes "..."first, then close.
- Premature completion claims:
- Never say a bead is done before running fresh
npm run typecheck,npm run lint,npm run test.
- Never say a bead is done before running fresh
- Scope confusion in parallel work:
- Worker agents must own one bead only and avoid touching unrelated files.
- Dependency direction mistakes:
- Validate blockers/ready semantics against dependency graph before changing status logic.
- Duplicate fixes across views:
- If logic affects Kanban and Graph, centralize shared logic; do not patch one page only.
- Stale realtime assumptions:
- Confirm DB + WAL + touch markers are watched and SSE fallback uses mtime/timestamps.
- Missing test registration:
- New test files must be included in
npm run testscript if the suite is explicitly enumerated.
- New test files must be included in
Session Completion (Landing the Plane)
When ending a coding session:
- Create beads for remaining follow-ups.
- Run quality gates if code changed.
- Update/close beads with notes and evidence.
- Sync and push:
git pull --rebase bd sync git push git status - Hand off with:
- what changed,
- what is verified,
- open risks/gaps,
- exact next bead(s).
Non-Negotiable Honesty Rule
Never claim:
- "done",
- "passing",
- "fixed",
- "closed"
unless you have run the proving command(s) in the current session and can cite results.