Skip to content

GitHub Title & Description

Owner Agent: Tomori（/maigo:describe-pr step 2——orchestrator 前置抓料後交給燈套用） Consumers: /maigo:describe-pr

Why this skill exists

PR title / description 是 reviewer 對這次變更的第一印象。常見的失敗： - title 抄最後一個 commit message（內部視角，reviewer 看不出價值） - description 只寫「改了 X / Y / Z」（檔案清單 reviewer 自己看 diff 就有） - 沒講為什麼（reviewer 得逆向工程動機） - 沒講怎麼驗證（reviewer 得自己想 test scope）

這個 skill 把這四件事變成有結構的 process。

Inputs（caller 必須給 / 自己抓的東西）

  1. Base branch（通常 main；caller 可覆寫）
  2. Branch commits：git log <base>..HEAD --pretty=format:'%h %s%n%b' --no-merges
  3. Branch diff stat：git diff <base>...HEAD --stat
  4. Branch diff：git diff <base>...HEAD（必要時 truncate）
  5. Repo commit-style 偵測（決定要不要參考既有 commit message 風格）： 偵測規則依 skills/commit-message Inputs 第 3 條（[tool.commitizen] / .cz.* / commitlint 設定檔 → Conventional Commits；皆無 → 自由格式）。 這只影響 commit message 風格參考；PR title 本身永不套 type: prefix。
  6. PR template（若存在）：caller 在 .github/PULL_REQUEST_TEMPLATE.md（含大小寫變體與 .github/PULL_REQUEST_TEMPLATE/ 目錄）找到的 template 內容。
  7. 找到 → 以 template 結構作為描述框架，填入從 commits / diff 萃取的內容，取代預設的 Why / What / Test Plan 結構
  8. 找不到 → 用本 skill 預設結構

Title 規則（user-impact 句子）

  • 一句話、user 視角：寫「使用者 / reviewer 看完會知道這 PR 做了什麼」
  • 開頭大寫（英文）；中文無此限
  • 不加 conventional-commits prefix（不要 feat:、fix:）
  • 長度建議 ≤ 72 字（GitHub UI 一行不截斷）
  • 不寫檔名：「Refactor auth.py」← bad；「Reject empty emails before hashing」← good
  • 動詞開頭 比名詞開頭更直接（「Add X」、「Fix Y」、「Allow Z」）

Bad → Good 對照

Bad Good
feat: add email validator Reject empty emails at signup
update auth.py and tests Block login when MFA token expired
WIP fix Stop retry storm on 5xx from upstream

Description 結構

必填三段（順序固定：Why → What → Test Plan）：

## Why
<為什麼要做：bug repro / 痛點 / 觸發場景。可以引用 issue / 對話 / log。1–3 句。>

## What
<2–4 句或 bullets：這個 PR 改了什麼行為。reviewer 讀完就知道要看什麼。>

## Test Plan
- <怎麼驗證：跑了哪些 test / 手動測了什麼 / 看了哪個 metric>
- <command + 預期結果>

可選段（有才加，不要為了塞而塞）：

## Breaking changes
<API / config / behaviour 改了什麼會打破既有 caller。沒有就不加這段。>

## Related issues
- Closes #<n>
- Refs #<n>

若 repo 有 PR template（Inputs 第 6 條）： - 以 template 的 section 結構作為描述框架 - 用 commits / diff 萃取的內容填入對應 section - template 內原有的 checklist / 說明文字保留在適當位置 - 不要增加 template 沒有的 section；不要刪掉 template 要求的 section - Why / What 必須保留：即使 template 沒有明確的 ## Why / ## What section，也要把這兩段作為 prose 加在 template 開頭的自由描述區（通常在第一條 --- 分隔線之前）。Why/What 是 reviewer 理解改動的最低資訊，不能因 template 不含它們就省略。

怎麼從 commits / diff 萃取這四段

段落 訊號來源
Why commit body 裡的「why」段、PR 描述對話、issue link
What branch commits 的主旨合併 + diff 摘要的 net effect
Test Plan diff 裡新增 / 改動的 test 檔 + 推測的手動驗證
Breaking changes public API signature 改變、config key 改名、預設值翻轉
Related issues commit message 裡的 #<n> / Closes #<n> / Refs #<n>

找不到 signal 不要編造——標記 <待補：...> 留給使用者填，不要 hallucinate。

Output format

skill 跑完直接給 caller 兩塊 markdown：

## Suggested PR title

<one line, user-impact>

## Suggested PR description

## Why
...

## What
...

## Test Plan
- ...

## Breaking changes  <!-- 若無，整段刪 -->
...

## Related issues  <!-- 若無，整段刪 -->
- Closes #...

Copy-paste 版本（caller 收尾用）

上面兩塊是 skill 回給 caller 的結構化輸出。caller（/maigo:describe-pr orchestrator） 在印給使用者時，額外再附一份「可整段複製」的 description：

  • 把 ## Suggested PR description 底下的 body 原封放進單一 fenced code block。
  • 外層 fence 用四個 backtick，避免 Test Plan 等內部三-backtick code block 把它截斷。
  • 緊接著用 **Title:** <one line> 給 title，方便一起複製。
  • 純淨版：不夾旁白、不夾額外提示；<待補：...> 佔位符保留讓使用者替換。

（skill 本身只負責產 body / title；組裝 copy-paste block 是 caller 的收尾步驟。）

caller 呈現最終 deliverable 給使用者時，遵守 skills/copyable-deliverable——把可複製的內容放進單一 fenced code block。

Verification discipline (references)

Verify every PR-state / API-signature / CLI-flag claim against live source before writing — reference docs go stale silently; use gh pr view, git show HEAD:<path>, or gh pr diff <n> to confirm. Details and a per-claim-type recipe in references/verification-discipline.md.

What this skill does NOT cover

  • 開 PR（這是 caller / 使用者 的 gh pr create 或 GitHub UI）
  • 寫 commit message（skill 只看既有 commits）
  • 改 commit history（rebase / squash 不是這裡的事）
  • 跑 test（test plan 是「描述要跑什麼」，不是跑它）