# AGENTS.md worklane is a local kanban board: a Rust CLI and a ratatui TUI over markdown files in a `.worklane/` directory. `src/main.rs` maps a parsed command to its handler, `src/tui.rs` draws the board, and `assets/` holds the agent documents the binary embeds and installs. ## Where the documentation is **How to use worklane is in `assets/SKILL.md`.** That document is what `worklane install-skill` ships, so it is the one place the flow, the move-as-you-work rule and the argument traps are written down. Read it before working a ticket in this repo. `assets/REVIEW.md`, `assets/PLAN.md` and `assets/ADMIN.md` are the same for reviewing a ticket, grooming the board and administering it. **Why worklane is built the way it is, is in `docs/`.** Start at [docs/INDEX.md](docs/INDEX.md), which says which file answers what. Read the entry for the subject you are changing before you change it: each one carries the reason a rule exists and what broke without it, and a rule undone by accident is the failure this split exists to prevent. Do not restate any of it here, and do not add a second copy anywhere else. A copy is a copy that goes stale, which is what happened to the skill document under `.opencode/` before b2c5531 deleted it. This file is the map and nothing else. ## The three rules that have no home but this one - **Run `make check` before committing**: `cargo fmt --check`, then `cargo clippy --all-targets -- -D warnings`, then `cargo test`, cheapest first. This repo has no CI and does not want any, so that command is the whole of the enforcement. See [docs/testing.md](docs/testing.md). - **Commit format is `([ticketID]) [short description]`**, and `--fixup` for incremental changes. See [docs/releasing.md](docs/releasing.md). - **Before every commit, decide whether the change warrants a version bump, and ask the user to confirm the bump and its kind before making it.** Never bump silently, and never skip the question because the answer looks obvious. `make patch`, `make minor` and `make major` do the mechanics. See [docs/releasing.md](docs/releasing.md). ## Adding to the documentation A new rule goes in the `docs/` file for its subject, as a bullet saying what the rule is and why it exists. A new subject gets its own file and a row in [docs/INDEX.md](docs/INDEX.md). A rule about how worklane is *used* goes in `assets/SKILL.md` instead, and reaches its readers through `install-skill`.