Update agents file

This commit is contained in:
2026-05-15 13:10:38 +02:00
parent cd19e4e6cf
commit 01e2daca13
3 changed files with 142 additions and 30 deletions
+39 -30
View File
@@ -1,46 +1,55 @@
# AGENTS.md
## Project Structure
- `src/main.rs` - All application logic (init, add, ls, show, mv commands)
- `src/main.rs` - All application logic
- `src/command.rs` - CLI argument definitions using clap derive
- `tests/` - Integration tests using `assert_cmd` and `assert_fs`
- Ticket files stored as `.md` in `.worklane/<status>/` directories
## Commands
| Command | Description |
|---------|-------------|
| `worklane init` | Creates `.worklane/` with backlog, committed, reviewing, done directories |
| `worklane add` | Creates a ticket in backlog with `--title`, `--description`, `--acceptance`, `--plan`, `--tags`, `--due`, `--owner` flags |
| `worklane ls` | Lists tickets, optionally filtered by `--status` |
| `worklane show <id>` | Shows ticket by UUID prefix or title |
| `worklane mv <id> --status <target> [-f]` | Moves ticket between statuses. Default: forward only, one stage at a time. `-f` bypasses both restrictions |
| `worklane comment <ticket> <body>` | Adds a comment to a ticket by UUID or title |
## Ticket File Format
Filenames: `<uuid_v4>_<slug>.md`
Metadata fields parsed: `ID`, `Tags`, `Due`, `Owner`, `Created At`, `Status`
- Filenames: `<uuid_v4>_<slug>.md`
- Metadata fields parsed by `parse_ticket_field()`: `ID`, `Tags`, `Due`, `Owner`, `Created At`, `Status`
- Format: `**Field Name**: value`
- Ticket structure: `# Title` → `## Description` → `## Acceptance Criteria` → `## Implementation Plan` → `## Metadata`
- Comments stored in `.worklane/comments/<ticket_uuid>/<timestamp>.md` with `**Comment**`, `**Author**`, `**Time**` fields
## Status Workflow
`backlog` -> `committed` -> `reviewing` -> `done`
`backlog` → `committed` → `reviewing` → `done`
## Testing
Run: `cargo test`
- Run: `cargo test`
- Tests use `assert_cmd` and `assert_fs` for CLI testing
- `setup_worklane()` creates temp `.worklane/` with all four status folders pre-created
- `create_ticket()` writes fully-formed markdown files directly (no `--` separator for positional args in test commands)
Tests create temporary `.worklane` directories with all four status folders pre-created via `setup_worklane()`. Ticket helper `create_ticket()` writes fully-formed markdown files directly.
## Coding Guidelines
## Key Implementation Notes
- No database or index - tickets resolved by scanning all status directories
- `resolve_ticket()` matches by UUID prefix (8+ chars), title substring, or filename substring
- Ambiguous searches (multiple matches) exit with list of options
- Ticket metadata uses `**Field**:` format for parsing
- Color output uses ANSI escape codes in `content_trim_colored()`
### Rust Style
- Use `if matches!(expr, Variant)` instead of `if let Some(Variant) = expr` for enum variant matching
- Use `if let Some(x) = expr` instead of `if let Some(Some(x)) = expr` — drop unnecessary nesting
- Prefer explicit `match` over `unwrap_or_default()` for clarity
- Use `unwrap_or_else(|| expr)` for lazy defaults, `unwrap_or(val)` for eager defaults
- Use `anyhow!()` with context strings that include identifying info (e.g. UUID, title) not bare values
## Agent workflow
### Color and Output
- Use `color_text()` helper for colored output — it respects `should_use_colors()` (terminal detection)
- Color codes are defined in `get_color()`: red (31), cyan (36), orange (33), green (32), grey (90)
- Reset color with `\x1b[0m` after colored text
- Bold uses `\x1b[1;35m` (magenta bold)
- Always test color output works correctly in both terminal and pipe modes
- When working on a ticket use `worklane show [ticketID]` to read the ticket.
- If the ticket status says backlog, move it to committed using `worklane mv --status committed [ticketID]`.
- Use `worklane comment [ticketID] "[body]"` to leave notes on tickets (e.g. "LGTM", "needs fixes", "blocked on X")
- Use git to commit your changes. The commit message should follow the format: `([ticketID]) [short description of changes]`
- If further changes are made later, use --fixup to commit them
- When your changes meet the acceptance criteria and the code compiles, move the ticket to reviewing using `worklane mv --status reviewing [ticketID]`
- When the ticket is approved, move it to done using `worklane mv --status done [ticketID]`
### Code Organization
- Colorization functions (`colorize_line`, `colorize_metadata`, `colorize_ordered`, `content_trim_colored`) handle markdown formatting
- `resolve_ticket()` scans all status directories — it's the single source for ticket lookup by UUID prefix, title, or filename
- `parse_ticket_field()` handles extracting metadata values from markdown format
### Ticket Resolution
- `resolve_ticket()` returns `(status, title, content)` tuple
- Priority: exact UUID prefix (8+ chars) > title substring > filename substring
- Ambiguous matches (multiple results) print options and exit(1)
- Never return empty strings for required fields — use `_Not set_` or `_None_` as defaults
### Git Workflow
- Commit format: `([ticketID]) [short description]`
- Use `--fixup` for incremental changes
- Test before moving to reviewing status