source: Klonkt/CLAUDE.md@ 1be21ba

main
Last change on this file since 1be21ba was 76e9cfd, checked in by robo <roboburr@…>, 4 months ago

bd init: initialize beads issue tracking

  • Property mode set to 100644
File size: 2.2 KB
Line 
1# Project Instructions for AI Agents
2
3This file provides instructions and context for AI coding agents working on this project.
4
5<!-- BEGIN BEADS INTEGRATION v:1 profile:minimal hash:7510c1e2 -->
6## Beads Issue Tracker
7
8This project uses **bd (beads)** for issue tracking. Run `bd prime` to see full workflow context and commands.
9
10### Quick Reference
11
12```bash
13bd ready # Find available work
14bd show <id> # View issue details
15bd update <id> --claim # Claim work
16bd close <id> # Complete work
17```
18
19### Rules
20
21- Use `bd` for ALL task tracking — do NOT use TodoWrite, TaskCreate, or markdown TODO lists
22- Run `bd prime` for detailed command reference and session close protocol
23- Use `bd remember` for persistent knowledge — do NOT use MEMORY.md files
24
25**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.
26
27## Session Completion
28
29**When ending a work session**, you MUST complete ALL steps below. Work is NOT complete until `git push` succeeds.
30
31**MANDATORY WORKFLOW:**
32
331. **File issues for remaining work** - Create issues for anything that needs follow-up
342. **Run quality gates** (if code changed) - Tests, linters, builds
353. **Update issue status** - Close finished work, update in-progress items
364. **PUSH TO REMOTE** - This is MANDATORY:
37 ```bash
38 git pull --rebase
39 git push
40 git status # MUST show "up to date with origin"
41 ```
425. **Clean up** - Clear stashes, prune remote branches
436. **Verify** - All changes committed AND pushed
447. **Hand off** - Provide context for next session
45
46**CRITICAL RULES:**
47- Work is NOT complete until `git push` succeeds
48- NEVER stop before pushing - that leaves work stranded locally
49- NEVER say "ready to push when you are" - YOU must push
50- If push fails, resolve and retry until it succeeds
51<!-- END BEADS INTEGRATION -->
52
53
54
55## Build & Test
56
57_Add your build and test commands here_
58
59```bash
60# Example:
61# npm install
62# npm test
63```
64
65## Architecture Overview
66
67_Add a brief overview of your project architecture_
68
69## Conventions & Patterns
70
71_Add your project-specific conventions here_
Note: See TracBrowser for help on using the repository browser.