blob: 3c42c8c2a6d1b37533b3678d0cb4515b1042ad30 (
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
|
# Omni
The Omni project is to leverage automation and asymmetries to create wealth.
## Critical Rules for AI Agents
**CRITICAL**: This project uses `task` for ALL issue tracking. You MUST follow these rules:
- ✅ Use `task` for ALL task/TODO tracking (`task create ... --json`)
- ✅ Link discovered work with `--discovered-from=<parent-id>`
- ✅ File bugs IMMEDIATELY when you discover unexpected behavior
- ✅ Run `task ready --json` before asking "what should I work on?"
- ✅ Store AI planning docs in `_/llm` directory (NEVER in repo root)
- ❌ Do NOT use `todo_write` tool
- ❌ Do NOT create markdown TODO lists or task checklists
- ❌ Do NOT put TODO/FIXME comments in code
## Cheat Sheet
**Standard workflow:**
```bash
# 1. Find ready work
task ready --json
# 2. Claim a task
task update <id> in-progress --json
# 3. During work: create discovered issues
task create "Fix type error found" --discovered-from=<current-id> --json
# 4. Complete the task
task update <id> done --json
```
**Bug Discovery:**
```bash
# Create a task immediately
task create "Command X fails when Y" --discovered-from=<current-task-id> --json
```
## Directory Structure
- **`_/`** (cabdir) - All ephemeral/generated files. This directory is gitignored.
- `_/llm/` - AI planning docs and agent logs
- `_/tmp/` - Temporary files, test databases, scratch data
- Never create dotfile directories (like `.tasks/`) in the repo root
## Documentation
- **Project Context**: [README.md](README.md) - Goals, source layout, and coding conventions.
- **Task Manager**: [`Omni/Task/README.md`](Omni/Task/README.md) - Detailed usage, dependency management, and agent best practices.
- **Build Tool (Bild)**: [`Omni/Bild/README.md`](Omni/Bild/README.md) - How to use `bild` and manage dependencies.
- **Development Tools**: [`Omni/Ide/README.md`](Omni/Ide/README.md) - `run.sh`, `lint`, `repl.sh`, git workflow.
|