| [5b22ea9] | 1 | # Project Instructions for AI Agents
|
|---|
| 2 |
|
|---|
| 3 | This file provides instructions and context for AI coding agents working on this project.
|
|---|
| 4 |
|
|---|
| [4cc4bcf] | 5 | > **The beads database in this repository is retired. Do not write to it.**
|
|---|
| 6 | >
|
|---|
| 7 | > Klonkt's issues live in `~/Sources/shaer-frontend/.beads` (Dolt database
|
|---|
| 8 | > `shaer`). All 32 of them were migrated there on 2026-08-23 keeping their
|
|---|
| 9 | > original `prutfolio-src-*` ids, so `bd show prutfolio-src-7cz` works from that
|
|---|
| 10 | > repository and means the same issue it always did.
|
|---|
| 11 | >
|
|---|
| 12 | > Create, update and close Klonkt issues from `~/Sources/shaer-frontend`. The
|
|---|
| 13 | > `bd` commands below apply there, not here.
|
|---|
| 14 | >
|
|---|
| 15 | > Why: this repository has no `core.hooksPath`, so the beads hooks in
|
|---|
| 16 | > `.beads/hooks/` never ran. The Dolt database is gitignored and the one tracked
|
|---|
| 17 | > artefact, `.beads/issues.jsonl`, is only refreshed by those hooks — it had
|
|---|
| 18 | > drifted four days and two issues behind before anyone noticed. shaer-frontend
|
|---|
| 19 | > has the hooks wired, so its export stays current.
|
|---|
| 20 | >
|
|---|
| 21 | > The local database is left in place and still readable for history. Nothing
|
|---|
| 22 | > enforces this: it is a convention, and a `bd create` run here will succeed and
|
|---|
| 23 | > be lost.
|
|---|
| 24 |
|
|---|
| [76e9cfd] | 25 | <!-- BEGIN BEADS INTEGRATION v:1 profile:minimal hash:7510c1e2 -->
|
|---|
| [5b22ea9] | 26 | ## Beads Issue Tracker
|
|---|
| 27 |
|
|---|
| 28 | This project uses **bd (beads)** for issue tracking. Run `bd prime` to see full workflow context and commands.
|
|---|
| 29 |
|
|---|
| 30 | ### Quick Reference
|
|---|
| 31 |
|
|---|
| 32 | ```bash
|
|---|
| 33 | bd ready # Find available work
|
|---|
| 34 | bd show <id> # View issue details
|
|---|
| 35 | bd update <id> --claim # Claim work
|
|---|
| 36 | bd close <id> # Complete work
|
|---|
| 37 | ```
|
|---|
| 38 |
|
|---|
| 39 | ### Rules
|
|---|
| 40 |
|
|---|
| 41 | - Use `bd` for ALL task tracking — do NOT use TodoWrite, TaskCreate, or markdown TODO lists
|
|---|
| 42 | - Run `bd prime` for detailed command reference and session close protocol
|
|---|
| 43 | - Use `bd remember` for persistent knowledge — do NOT use MEMORY.md files
|
|---|
| 44 |
|
|---|
| [76e9cfd] | 45 | **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.
|
|---|
| 46 |
|
|---|
| [5b22ea9] | 47 | ## Session Completion
|
|---|
| 48 |
|
|---|
| 49 | **When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds.
|
|---|
| 50 |
|
|---|
| 51 | **MANDATORY WORKFLOW:**
|
|---|
| 52 |
|
|---|
| 53 | 1. **File issues for remaining work** - Create issues for anything that needs follow-up
|
|---|
| 54 | 2. **Run quality gates** (if code changed) - Tests, linters, builds
|
|---|
| 55 | 3. **Update issue status** - Close finished work, update in-progress items
|
|---|
| 56 | 4. **PUSH TO REMOTE** - This is MANDATORY:
|
|---|
| 57 | ```bash
|
|---|
| 58 | git pull --rebase
|
|---|
| 59 | git push
|
|---|
| 60 | git status # MUST show "up to date with origin"
|
|---|
| 61 | ```
|
|---|
| 62 | 5. **Clean up** - Clear stashes, prune remote branches
|
|---|
| 63 | 6. **Verify** - All changes committed AND pushed
|
|---|
| 64 | 7. **Hand off** - Provide context for next session
|
|---|
| 65 |
|
|---|
| 66 | **CRITICAL RULES:**
|
|---|
| 67 | - Work is NOT complete until `git push` succeeds
|
|---|
| 68 | - NEVER stop before pushing - that leaves work stranded locally
|
|---|
| 69 | - NEVER say "ready to push when you are" - YOU must push
|
|---|
| 70 | - If push fails, resolve and retry until it succeeds
|
|---|
| 71 | <!-- END BEADS INTEGRATION -->
|
|---|
| 72 |
|
|---|
| 73 |
|
|---|
| [76e9cfd] | 74 |
|
|---|
| [5b22ea9] | 75 | ## Build & Test
|
|---|
| 76 |
|
|---|
| 77 | ```bash
|
|---|
| [fcc9f25] | 78 | npm start # production: node src/server.js
|
|---|
| 79 | npm run dev # watch mode
|
|---|
| 80 | npm test # unit tests (built-in node:test runner, no extra deps)
|
|---|
| [5b22ea9] | 81 | ```
|
|---|
| 82 |
|
|---|
| [fcc9f25] | 83 | Tests live in `test/*.test.js` and run against an in-memory SQLite
|
|---|
| 84 | (`DATABASE_PATH=':memory:'`), so they never touch real data. Cover new
|
|---|
| [7e9d0ea] | 85 | permission logic with tests — `PermissionsService.canAdminSite` was once
|
|---|
| 86 | silently broken; see `test/site-permissions.test.js`.
|
|---|
| [586f9dd] | 87 |
|
|---|
| [5b22ea9] | 88 | ## Architecture Overview
|
|---|
| 89 |
|
|---|
| 90 | _Add a brief overview of your project architecture_
|
|---|
| 91 |
|
|---|
| 92 | ## Conventions & Patterns
|
|---|
| 93 |
|
|---|
| [87696ce] | 94 | - **Bump `MOD_V` whenever you change anything in `src/assets/js/mod/`.** It sits
|
|---|
| 95 | at the top of the module loader in `src/views/shell.ejs` and is the
|
|---|
| 96 | cache-buster for every page module. `/assets` is served `max-age=1y` outside
|
|---|
| 97 | development, so without a bump a browser that visited before keeps running the
|
|---|
| 98 | old module for a year — meaning a fix reaches everyone *except* the people who
|
|---|
| 99 | already have the bug. Same discipline as `audio-player.js?v=N` a few hundred
|
|---|
| 100 | lines up. One number for the whole directory: bumping too often costs one
|
|---|
| 101 | download, bumping too rarely costs a bugfix that never arrives.
|
|---|
| 102 |
|
|---|
| 103 | - **Comments and commit messages in Dutch, identifiers in English.** The modules
|
|---|
| 104 | in `assets/js/mod` read `setIcon`, `uploadOne`, `applyAccent`; the comments
|
|---|
| 105 | around them are Dutch prose. Both halves matter — a Dutch identifier in an
|
|---|
| 106 | English file is the same wrong note as an English comment in a Dutch one. This
|
|---|
| 107 | extends to anything long-lived and outward-facing: URL paths and CSS class
|
|---|
| 108 | names are English (`/read`, `.read-end`), never a Dutch verb form.
|
|---|