ticket-workflow: Instructions file for Claude Code

ticket-workflow

This repo follows its own guardrail standard. node dist/cli/index.js audit . (after a build) is the machine-checkable definition; this file is a pointer to it, not a second copy.

What this package is

The canonical ticket engine: MCP server, guard/telemetry hooks, pipeline CLI (list, show, doctor, verify, audit, init), the guardrail template set, and the audit that checks any repo against the standard. Consumers (kanban first) pin it by git tag, never a branch — a fix here reaches them only through a tag cut plus their own pin bump.

Public and user-agnostic — hard rule

This is a public repo. Never commit a local identifier: no home-directory path naming a real account, no machine-local board paths, no private hostnames.

Enforced in the gate, not by a grep you have to remember. src/repoHygiene.test.ts scans the index — the snapshot that will actually commit — for ~user/, /Users/user and /home/user (plus off-case /users/ and /Home/; see gap 4 and the false positives below), failing unless the owner is an obvious placeholder (someuser, x, runner, …). The consequence to know when running it locally: an unstaged edit is not scanned. git add first, or the run reports on a file you have already changed. src/templates.test.ts holds template contents to the same standard separately.

This replaced a hand-run git grep with a hardcoded exclusion list, which rotted the worst way: the list went stale, so it reported a hit on every clean run while the identifier that was actually committed — a real account name in a ~user/ path — sat in a shape it never matched. A check that always fires is a check people stop reading (tkt-3a91af2aa6d9).

What it fails on rather than skips (tkt-87b8b9b60b24): a tracked symlink, submodule or conflicted index entry, which git grep --cached never reads; a file the scan's -I skips as binary; and a path containing a newline, which breaks record parsing. Each reddens the gate for a human to judge instead of passing as clean. An empty file is fine; a tracked symlink is not.