-
Notifications
You must be signed in to change notification settings - Fork 0
docs: record the issue tracker, triage labels and domain doc layout #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c8b3a74
docs: record the issue tracker, triage labels and domain doc layout
marcinpsk 3e0dd61
fix: let a merge commit subject bump the version
marcinpsk 8db02c3
docs: correct the gh commands in the issue tracker skill
marcinpsk c35b8bd
ci: move opengrep to a pre-commit hook and audit the workflows with z…
marcinpsk 2e33899
test: check every documented gh --json field against the real CLI
marcinpsk 6a503e5
ci: audit the whole repo with zizmor, and give Dependabot a cooldown
marcinpsk 6819217
fix: parse documented commands once, and page the external-PR query c…
marcinpsk 09139b9
fix: fetch body in the frontier child query, and guard prose against …
marcinpsk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Local hooks only. The repository's other gates run in CI; this file exists so the | ||
| # custom opengrep ruleset runs somewhere, because CodeRabbit skips its own opengrep pass | ||
| # when it sees opengrep in the workflows. See .opengrep/README.md. | ||
| # | ||
| # Install with: pre-commit install --install-hooks | ||
| repos: | ||
| - repo: local | ||
| hooks: | ||
| # The scripts scan the whole crate, so filenames are not passed. `files` still | ||
| # decides whether the hook runs at all, which keeps a docs-only commit free. | ||
| - id: opengrep-rule-tests | ||
| name: opengrep rule-tests | ||
| entry: scripts/opengrep-test.sh | ||
| language: script | ||
| pass_filenames: false | ||
| files: ^\.opengrep/ | ||
| # Rules changing can flag code that already exists, so run the scan for those too. | ||
| - id: opengrep | ||
| name: opengrep (custom agentx-ifstack rules) | ||
| entry: scripts/opengrep-scan.sh | ||
| language: script | ||
| pass_filenames: false | ||
| files: ^(src/.*\.rs|\.opengrep/.*)$ | ||
|
|
||
| default_install_hook_types: [pre-commit] | ||
| default_stages: [pre-commit] | ||
| fail_fast: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Domain Docs | ||
|
|
||
| How the engineering skills should consume this repo's domain documentation when exploring the codebase. | ||
|
|
||
| ## Before exploring, read these | ||
|
|
||
| - **`CONTEXT.md`** at the repo root, or | ||
| - **`CONTEXT-MAP.md`** at the repo root if it exists: it points at one `CONTEXT.md` per context. Read each one relevant to the topic. | ||
| - **`docs/adr/`**: read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions. | ||
|
|
||
| If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved. | ||
|
|
||
| ## File structure | ||
|
|
||
| Single-context repo (most repos): | ||
|
|
||
| ``` | ||
| / | ||
| ├── CONTEXT.md | ||
| ├── docs/adr/ | ||
| │ ├── 0001-event-sourced-orders.md | ||
| │ └── 0002-postgres-for-write-model.md | ||
| └── src/ | ||
| ``` | ||
|
|
||
| Multi-context repo (presence of `CONTEXT-MAP.md` at the root): | ||
|
|
||
| ``` | ||
| / | ||
| ├── CONTEXT-MAP.md | ||
| ├── docs/adr/ ← system-wide decisions | ||
| └── src/ | ||
| ├── ordering/ | ||
| │ ├── CONTEXT.md | ||
| │ └── docs/adr/ ← context-specific decisions | ||
| └── billing/ | ||
| ├── CONTEXT.md | ||
| └── docs/adr/ | ||
| ``` | ||
|
|
||
| ## Use the glossary's vocabulary | ||
|
|
||
| When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids. | ||
|
|
||
| If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`). | ||
|
|
||
| ## Flag ADR conflicts | ||
|
|
||
| If your output contradicts an existing ADR, surface it explicitly rather than silently overriding: | ||
|
|
||
| > _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Issue tracker: GitHub | ||
|
|
||
| Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations. | ||
|
|
||
| ## Conventions | ||
|
|
||
| - **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies. | ||
| - **Read an issue**: `gh issue view <number> --json number,title,body,labels,comments --jq '...'`. `--comments` prints human-readable output, so it cannot feed `jq`; use `--json` for structured reads. | ||
| - **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. | ||
| - **Comment on an issue**: `gh issue comment <number> --body "..."` | ||
| - **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."` | ||
| - **Close**: `gh issue close <number> --comment "..."` | ||
|
|
||
| Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone. | ||
|
|
||
| ## Pull requests as a triage surface | ||
|
|
||
| **PRs as a request surface: yes.** _(External pull requests are treated as feature requests and run through the same labels and states as issues; `/triage` reads this flag. Set to `no` to exclude them.)_ | ||
|
|
||
| When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents: | ||
|
|
||
| - **Read a PR**: `gh pr view <number> --comments` and `gh pr diff <number>` for the diff. | ||
| - **List external PRs for triage**: `gh pr list --json` has no `authorAssociation` field and fails with "Unknown JSON field". Use the REST endpoint, which exposes `author_association`: `gh api "repos/<owner>/<repo>/pulls?state=open" --paginate --slurp | jq '[.[][] | select(.author_association | IN("CONTRIBUTOR","FIRST_TIME_CONTRIBUTOR","NONE")) | {number, title, author: .user.login, author_association}]'` (drop `OWNER`/`MEMBER`/`COLLABORATOR`). | ||
| - **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`. | ||
|
|
||
| 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`. | ||
|
|
||
| ## When a skill says "publish to the issue tracker" | ||
|
|
||
| Create a GitHub issue. | ||
|
|
||
| ## When a skill says "fetch the relevant ticket" | ||
|
|
||
| Run `gh pr view <number> --comments` and fall back to `gh issue view <number> --comments`. | ||
|
|
||
| ## Wayfinding operations | ||
|
|
||
| Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets. | ||
|
|
||
| - **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`. | ||
| - **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. | ||
| - **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. | ||
| - **Frontier query**: read the map's children in order with `gh issue view <map> --json subIssues`, then check each child's `gh issue view <n> --json state,blockedBy,assignees,body`; skip any that is closed, has an open entry in `blockedBy`, or has an assignee. The first eligible child in map order wins. Do not use `gh issue list`, which returns the 30 most recent issues by default and does not preserve map order. Where sub-issues are unavailable, walk the task list in the map body in the same order. Read each child's `body` regardless of how the children were listed: dependencies and sub-issues are separate features, so a repository can list children natively while recording blockers as a `Blocked by: #<n>` line, and such a child has an empty `blockedBy`, so treat an open issue named in `body` as a blocker. | ||
| - **Claim**: `gh issue edit <n> --add-assignee @me`, the session's first write. | ||
| - **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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Triage Labels | ||
|
|
||
| The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker. | ||
|
|
||
| | Label in mattpocock/skills | Label in our tracker | Meaning | | ||
| | -------------------------- | -------------------- | ---------------------------------------- | | ||
| | `needs-triage` | `needs-triage` | Maintainer needs to evaluate this issue | | ||
| | `needs-info` | `needs-info` | Waiting on reporter for more information | | ||
| | `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent | | ||
| | `ready-for-human` | `ready-for-human` | Requires human implementation | | ||
| | `wontfix` | `wontfix` | Will not be actioned | | ||
|
|
||
| When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table. | ||
|
|
||
| Edit the right-hand column to match whatever vocabulary you actually use. | ||
|
|
||
| `wontfix` already existed in this repo, so it is reused rather than recreated. The other | ||
| four were created for these roles. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.