Files

1.8 KiB

Project instructions

Beads

This project uses bd (Beads) as the source of truth for work tracking.

At the beginning of a work session run:

bd prime
bd status
bd ready --exclude-type epic

Claim the selected bead before changing code and close it only after its acceptance criteria and relevant checks pass. Create follow-up beads for newly discovered work and connect real blockers with bd dep add.

The Git remote is origin at ssh://git@git.pryanik.synology.me:2222/huncode/goon-game.git; master tracks origin/master. The Beads database uses embedded Dolt. A Dolt remote entry exists locally, but publishing the separate Dolt history requires explicit owner authorization; normal git push publishes the versioned .beads/issues.jsonl snapshot, not the embedded database.

At the end of a session:

  1. run the relevant quality gates;
  2. update or close the active bead;
  3. run bd dep cycles after dependency changes;
  4. export a readable snapshot with bd export --output .beads/issues.jsonl;
  5. commit source and tracking changes;
  6. run git pull --rebase and git push;
  7. verify git status --short --branch shows the branch tracking origin/master without local changes.

Do not edit .beads/issues.jsonl manually. The source of truth is .beads/embeddeddolt. Do not run bd dolt push unless the owner explicitly authorizes publishing that separate tracking history.

Build and tests

./gradlew clean testDebugUnitTest lintDebug assembleDebug
./gradlew connectedDebugAndroidTest

The connected test command requires a running Android device or emulator.

Product documents

  • docs/DEVELOPMENT_PLAN.md — approved GDD + TDD + production roadmap.
  • docs/CURRENT_ROADMAP.md — current execution sequence.
  • docs/BEADS_WORKFLOW.md — backlog structure and operator commands.