|
| 1 | +# Issue tracker: GitHub |
| 2 | + |
| 3 | +Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations. |
| 4 | + |
| 5 | +## Conventions |
| 6 | + |
| 7 | +- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies. |
| 8 | +- **Read an issue**: `gh issue view <number> --comments`, filtering comments by `jq` and also fetching labels. |
| 9 | +- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters. |
| 10 | +- **Comment on an issue**: `gh issue comment <number> --body "..."` |
| 11 | +- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."` |
| 12 | +- **Close**: `gh issue close <number> --comment "..."` |
| 13 | + |
| 14 | +Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone. |
| 15 | + |
| 16 | +## Pull requests as a triage surface |
| 17 | + |
| 18 | +**PRs as a request surface: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_ |
| 19 | + |
| 20 | +When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents: |
| 21 | + |
| 22 | +- **Read a PR**: `gh pr view <number> --comments` and `gh pr diff <number>` for the diff. |
| 23 | +- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`). |
| 24 | +- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`. |
| 25 | + |
| 26 | +GitHub shares one number space across issues and PRs, so a bare `#42` may be either: resolve with `gh pr view 42` and fall back to `gh issue view 42`. |
| 27 | + |
| 28 | +## When a skill says "publish to the issue tracker" |
| 29 | + |
| 30 | +Create a GitHub issue. |
| 31 | + |
| 32 | +## When a skill says "fetch the relevant ticket" |
| 33 | + |
| 34 | +Run `gh issue view <number> --comments`. |
| 35 | + |
| 36 | +## Wayfinding operations |
| 37 | + |
| 38 | +Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets. |
| 39 | + |
| 40 | +- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`. |
| 41 | +- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev. |
| 42 | +- **Blocking**: GitHub's **native issue dependencies**, the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only, the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed. |
| 43 | +- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins. |
| 44 | +- **Claim**: `gh issue edit <n> --add-assignee @me`, the session's first write. |
| 45 | +- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far. |
0 commit comments