diff --git a/skills/spec-start-github/SKILL.md b/skills/spec-start-github/SKILL.md new file mode 100644 index 000000000..de58170ac --- /dev/null +++ b/skills/spec-start-github/SKILL.md @@ -0,0 +1,80 @@ +--- +name: spec-start-github +description: >- + Binds the headless spec-start workflow to GitHub: use a triage issue as the + canonical prompt, work on agent/-spec-* branches, commit planning + artifacts, then either open a PR locally or stop before push when a harness + post-script owns GitHub writes. Pair with the spec-start skill for procedure. +# Cursor Agent Skills: prefer explicit @-style invocation; other tooling may ignore. +disable-model-invocation: true +--- + +# spec-start-github (issue-driven spec, artifacts on a PR) + +Use this skill **together with `spec-start`**: mount or invoke both in the same session so the headless planning checklist, hard-gate, `spec.md` / `qna.md` shape, and self-review are defined in **one place** (`spec-start`). This document only adds **GitHub + git + PR** mechanics. **Do not** duplicate or paraphrase `spec-start` at length. + +If the user’s prompt asks for another workflow or skill, follow that; this skill does not mandate unrelated skills. + +## Relationship to `spec-start` + +1. Use the steps below to fetch the issue, decide canonical prompt text, and prepare the branch. +2. Run the **full headless spec pass exactly as `spec-start` specifies** (topic directory, files, gates, final reply expectations). Treat the issue title and body (plus comment context per below) as the **prompt** you would otherwise have read from chat. + +## Inputs + +- **`ISSUE_NUMBER`** — required for `gh issue view` when not inferred from `GITHUB_ISSUE_URL`. +- **`GITHUB_ISSUE_URL`** — optional HTML URL; when set, it must match `ISSUE_NUMBER` and the repo you are working in (same checks fullsend pre-scripts use: same owner/repo, same issue number). +- **`TARGET_BRANCH`** — optional; default integration branch is usually `main` (discover with `git rev-parse --abbrev-ref origin/HEAD` if unsure). + +Harness authors may set **`SPEC_START_GITHUB_POST_SCRIPT_PUSHES=1`** (or equivalent session wording) so “post-automation opens the PR” is explicit; **primary** signal remains **session / wrapper instructions** that say push and `gh pr create` are out of bounds. + +## Step 1 — Fetch the issue + +```bash +echo "::notice::STEP 1: Fetch GitHub issue" +gh issue view "${ISSUE_NUMBER}" --json number,title,body,labels,comments,state,author +``` + +If the issue is closed (and the run is not explicitly for historical spec capture), stop unless the user or harness says otherwise. + +## Step 2 — Canonical prompt + +- **Primary intent:** issue **title** and **body**. Build an internal prompt string from them; that text is authoritative over incidental chat in the session. +- **Comments:** use as supporting context (triage notes, clarifications). Do **not** let comments override the issue body unless the body explicitly points at a specific comment. + +## Step 3 — Branch (collision-aware) + +Implementation-style agents often use `agent/-`. For spec-only work, use: + +`agent/-spec-` + +Use **2–4 lowercase hyphenated words** from the issue title for ``. Fetch `origin` and branch from **`TARGET_BRANCH`** or the repo default. + +**Existing work:** if a branch matching `agent/-spec-*` already exists, inspect it. If an **open** PR already targets it, **stop** without new commits (same scope guard as implementation agents: avoid piling on under review). If the branch exists but no open PR, check it out and continue only to fix verification gaps the user or harness asked for—do not rewrite unrelated spec prose. + +## Step 4 — Headless spec pass (`spec-start`) + +Follow **`spec-start`** for the uninterrupted planning pass and for **all** artifact rules (paths under `docs/plans/`, `spec.md`, `qna.md`, optional assets, commit-only-if-asked default from `spec-start`, and final reply bullets). + +In `spec.md` **Context**, include the issue URL, number, and title. + +## Step 5 — Commit + +This skill assumes a **commit is intended** whenever you are on a feature branch for a publish path (local PR or harness handoff). That overrides `spec-start`’s default “commit only if explicitly asked” for **chat-only** runs. + +Stage **only** files under the topic directory you created (and optional assets there). Use the repo’s commit conventions if you can infer them; include **`Refs #`** in the commit body unless merging this PR should close the issue (then **`Closes #N`** is appropriate). + +Run **`scan-secrets`** on changed paths if available; run **pre-commit** on those files if the repo uses it and time allows—otherwise disclose skips. No production test suite is required for docs-only output (`spec-start` scope). + +## Step 6 — Publish (local vs harness) + +| Mode | When | Agent actions | +|------|------|-----------------| +| **Local** | Default when session does **not** say automation owns push/PR | `git push -u origin` the feature branch (use existing auth). Then **`gh pr create`** against the integration branch with: PR title aligned with repo conventions; body with **link to the issue**, **`Refs #N`** (or `Part of #N`) by default so the issue stays open for implementation work, **topic directory path**, one-paragraph **recommended approach**, **top three open questions** from `qna.md`, and a short “what to review” (`spec.md` / `qna.md`). Avoid **`Closes #N`** unless closing the issue on merge is intended. | +| **Harness** | Session or wrapper says **post-automation** opens the PR / push | **Do not** `git push`. **Do not** `gh pr create` or `gh pr edit`. Stop after commit; in the final reply, give the **suggested PR title** and **full PR body** so a post-script or human can open the PR. | + +Some runner scripts append **`Closes #N`** to PR bodies automatically. Harness authors should prefer **`Refs`** for spec-only PRs when they control templates. + +## Aftercare + +Mirror `spec-start`: list topic path, summarize the recommended approach, surface top open questions. If harness mode, also paste the suggested PR title and body. diff --git a/skills/spec-start/SKILL.md b/skills/spec-start/SKILL.md index aafbad325..214ac0320 100644 --- a/skills/spec-start/SKILL.md +++ b/skills/spec-start/SKILL.md @@ -5,13 +5,16 @@ description: >- directory under docs/plans/ with spec.md and qna.md only, using the same design discipline as an interactive brainstorm but without blocking questions. Use for one-shot spec generation, GitHub-bound planning agents, or when the - user invokes spec-start without back-and-forth clarification. + user invokes spec-start without back-and-forth clarification. For issue URL + as canonical prompt plus branch/PR flow, pair with spec-start-github. # Cursor Agent Skills: prefer explicit @-style invocation; other tooling may ignore. disable-model-invocation: true --- # spec-start (headless spec kickoff) +For **GitHub issue as canonical prompt** (fetch issue, `agent/-spec-*` branch, local or harness PR), use **`spec-start-github`** together with this skill. + Help turn ideas into fully formed designs and specs **without** natural collaborative dialogue: run **once**, infer missing intent from the prompt and repo, and **write** the results to disk. Start by understanding the current project context (files, docs, recent commits). **Do not** ask questions one at a time or wait for approval between sections—when something is unclear, **capture it** in `qna.md` as assumptions and open questions.