-
Notifications
You must be signed in to change notification settings - Fork 1
Configure engineering skills #209
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # 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 repository root. | ||
| - **`docs/adr/`** — read ADRs that touch the area you're about to work in. | ||
|
|
||
| If these files don't exist, **proceed silently**. Don't flag their absence or suggest creating them upfront. The `/domain-modeling` skill creates them lazily when terms or decisions actually get resolved. | ||
|
|
||
| ## File structure | ||
|
|
||
| RustAuth uses a single domain context shared by its core, capability, integration, and adapter crates: | ||
|
|
||
| ```text | ||
| / | ||
| ├── CONTEXT.md | ||
| ├── docs/ | ||
| │ └── adr/ | ||
| └── crates/ | ||
| ├── rustauth-core/ | ||
| ├── rustauth/ | ||
| └── rustauth-*/ | ||
| ``` | ||
|
|
||
| Crate boundaries organize implementation and dependencies; they do not imply separate domain contexts. Repository-wide architectural decisions belong in `docs/adr/`. | ||
|
|
||
| ## Use the glossary's vocabulary | ||
|
|
||
| When your output names a domain concept—in an issue title, refactor proposal, hypothesis, or test name—use the term defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids. | ||
|
|
||
| If the concept you need isn't in the glossary yet, reconsider whether you're inventing language the project doesn't use. If it represents 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 — 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 PRDs 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> --comments`, filtering comments by `jq` and also fetching labels. | ||
| - **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: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_ | ||
|
|
||
| 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 --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`). | ||
| - **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 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**: 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. | ||
| - **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,15 @@ | ||
| # 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. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When skills run in this checkout,
git remote -vand the local Git configuration contain no remotes, soghcannot infer a repository; the issue and PR commands documented above omit--repoand will stop before reading or creating anything. Specifysalasebas/rustauthwith--repo, or document a requiredGH_REPOfallback.Useful? React with 👍 / 👎.