# Project Instructions for AI Agents This file provides instructions and context for AI coding agents working on this project. ## Beads Issue Tracker This project uses **bd (beads)** for issue tracking. Run `bd prime` to see full workflow context and commands. ### Quick Reference ```bash bd ready # Find available work bd show # View issue details bd update --claim # Claim work bd close # Complete work ``` ### Rules - Use `bd` for ALL task tracking — do NOT use TodoWrite, TaskCreate, or markdown TODO lists - Run `bd prime` for detailed command reference and session close protocol - Use `bd remember` for persistent knowledge — do NOT use MEMORY.md files **Architecture in one line:** issues live in a local Dolt DB; sync uses `refs/dolt/data` on your git remote; `.beads/issues.jsonl` is a passive export. See https://github.com/gastownhall/beads/blob/main/docs/SYNC_CONCEPTS.md for details and anti-patterns. ## Session Completion **When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds. **MANDATORY WORKFLOW:** 1. **File issues for remaining work** - Create issues for anything that needs follow-up 2. **Run quality gates** (if code changed) - Tests, linters, builds 3. **Update issue status** - Close finished work, update in-progress items 4. **PUSH TO REMOTE** - This is MANDATORY: ```bash git pull --rebase git push git status # MUST show "up to date with origin" ``` 5. **Clean up** - Clear stashes, prune remote branches 6. **Verify** - All changes committed AND pushed 7. **Hand off** - Provide context for next session **CRITICAL RULES:** - Work is NOT complete until `git push` succeeds - NEVER stop before pushing - that leaves work stranded locally - NEVER say "ready to push when you are" - YOU must push - If push fails, resolve and retry until it succeeds ## Build & Test ```bash npm start # production: node src/server.js npm run dev # watch mode npm test # unit tests (built-in node:test runner, no extra deps) ``` Tests live in `test/*.test.js` and run against an in-memory SQLite (`DATABASE_PATH=':memory:'`), so they never touch real data. Cover new permission logic with tests — `PermissionsService.canAdminSite` was once silently broken; see `test/site-permissions.test.js`. ## Architecture Overview _Add a brief overview of your project architecture_ ## Conventions & Patterns - **Bump `MOD_V` whenever you change anything in `src/assets/js/mod/`.** It sits at the top of the module loader in `src/views/shell.ejs` and is the cache-buster for every page module. `/assets` is served `max-age=1y` outside development, so without a bump a browser that visited before keeps running the old module for a year — meaning a fix reaches everyone *except* the people who already have the bug. Same discipline as `audio-player.js?v=N` a few hundred lines up. One number for the whole directory: bumping too often costs one download, bumping too rarely costs a bugfix that never arrives. - **Comments and commit messages in Dutch, identifiers in English.** The modules in `assets/js/mod` read `setIcon`, `uploadOne`, `applyAccent`; the comments around them are Dutch prose. Both halves matter — a Dutch identifier in an English file is the same wrong note as an English comment in a Dutch one. This extends to anything long-lived and outward-facing: URL paths and CSS class names are English (`/read`, `.read-end`), never a Dutch verb form.