From 52f6961e3e98127e55f81a53d49b5171425f66e5 Mon Sep 17 00:00:00 2001 From: Elijah Voigt Date: Sun, 22 Feb 2026 19:47:22 -0800 Subject: [PATCH] docs(nbd): default to --ftype md when creating tickets Update CLAUDE.md workflow guidance and the claude_md_snippet to always use --ftype md on nbd create, so ticket bodies are stored as human-readable markdown files. Co-Authored-By: Claude Sonnet 4.6 --- nbd/CLAUDE.md | 5 +++-- nbd/src/claude_md_snippet.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/nbd/CLAUDE.md b/nbd/CLAUDE.md index 8ae8158..45a6cbe 100644 --- a/nbd/CLAUDE.md +++ b/nbd/CLAUDE.md @@ -99,10 +99,10 @@ cargo run -- init Always pass `--json` to every command. Use `jq` to parse and transform the JSON output if necessary. -**Before starting work:** Create a ticket for the task. +**Before starting work:** Create a ticket for the task. Use `--ftype md` so the body is stored as human-readable markdown. ```sh -cargo run -- create --title "Add partial ID matching" --type feature --priority 7 --json +cargo run -- create --title "Add partial ID matching" --type feature --priority 7 --ftype md --json ``` **When starting a task:** Update its status. @@ -144,6 +144,7 @@ cargo run -- read --json ### Guidelines - **Always use `--json`.** It gives structured, unambiguous output on every command. +- **Always use `--ftype md`** when creating tickets. Markdown format keeps the body human-readable in the file browser. - Create tickets *before* starting non-trivial tasks, not after. - Use `--deps id1,id2` to express blockers — tickets that must be done first. - `--priority` follows 0–10: use 7–9 for bugs, 5 for normal tasks, 3 for nice-to-haves. diff --git a/nbd/src/claude_md_snippet.md b/nbd/src/claude_md_snippet.md index 6703039..7e6b31a 100644 --- a/nbd/src/claude_md_snippet.md +++ b/nbd/src/claude_md_snippet.md @@ -13,8 +13,8 @@ Run once in the project root. Creates `.nbd/tickets/`. Safe to run multiple time ### Core commands ```sh -# Create a new ticket -nbd create --title "Add OAuth login" --type feature --priority 7 +# Create a new ticket (use --ftype md for a human-readable body) +nbd create --title "Add OAuth login" --type feature --priority 7 --ftype md # List all open tickets (sorted by priority) nbd list @@ -46,6 +46,7 @@ nbd next ### Guidelines - **Always pass `--json`** to every command for structured, unambiguous output. +- **Always pass `--ftype md`** when creating tickets — markdown format keeps the body human-readable. - Use `jq` to parse and transform JSON output when needed. - Priority scale 0–10: use **7–9** for bugs, **5** for normal tasks, **3** for nice-to-haves. - `--type` choices: `project`, `feature`, `task`, `bug`.