aboutsummaryrefslogtreecommitdiff
path: root/CLAUDE.md
blob: e0820caa72b5dd1afa8567c9136a1984454c6a4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# Project Instructions for AI Agents

**Source of truth: [AGENTS.md](AGENTS.md) — read it first.**

This file is a lightweight mirror for agents that look for `CLAUDE.md`. If the
two disagree, `AGENTS.md` wins. The beads block below is auto-managed by the
`bd` hooks.

The short version:

- **Build & Test**: `composer install` once, then `composer check` (lint +
  unit tests) before finishing work. `composer bench` for the scaling
  benchmark.
- **Tracking**: use `bd` for ALL task tracking — never TodoWrite or markdown
  TODO lists. Serialize `bd` commands (embedded Dolt is single-writer).
- **Changelog**: every user-facing change gets a line under `[Unreleased]` in
  `CHANGELOG.md`.
- **Session close**: file issues for remaining work, run `composer check`,
  update issue status, then push (`git pull --rebase`, `bd dolt push`,
  `git push`). Work is not complete until the push succeeds.

<!-- BEGIN BEADS INTEGRATION v:1 profile:minimal hash:ca08a54f -->
## 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 <id>          # View issue details
bd update <id> --claim  # Claim work
bd close <id>         # 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

## 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
   bd dolt push
   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
<!-- END BEADS INTEGRATION -->