Detailed Pr Description

biw/skills/skills/detailed-pr-description

作者 biw5b8d923883cf29dcfe0bd1c16f6e886590c7e284無授權條款2 個星標收錄於 2026年10月9日更新於 2026年10月9日儲存庫6 天前更新

Assess test coverage or draft/update GitHub PR descriptions with self-contained context, risks, follow-up work, focused code references, and validation results.

AI 產生的概覽

評估分支測試覆蓋度,並依據證據草擬或更新 GitHub PR 說明,包含風險與驗證結果。

功能
此技能引導代理評估分支測試是否足夠紮實,並草擬或更新 GitHub 提取請求說明。它會從 git 狀態、差異、提交、變更檔案、測試、文件、遷移與設定中蒐集證據,然後產出一份自足的 PR 內文,涵蓋問題、做法、結果、風險、相容性、邊界情況與驗證結果。它也能給出覆蓋度判斷(充足、部分充足或不足),並在明確授權時寫入草稿檔案或將內文發布到 GitHub。
適用情境
當提取請求需要一份詳盡且有證據支撐的說明時,或當你想在審查前誠實判斷分支測試是否充足時使用。它適合需要為審查者記錄 PR 背景、風險與驗證結果的工作流程。
執行需求
需要 git 與 GitHub CLI(gh)來檢查與發布 PR,並需要儲存庫存取權限及連線至 GitHub 的網路。它不附帶指令碼,依賴 PR 內文範本資源與選用的代理設定。

Detailed PR Description

Resolve the outcome

  • Assessment: judge whether branch tests are strong enough; do not draft or update a PR body.
  • Draft: produce a proposed body locally or in the response; do not mutate GitHub.
  • Update/post: draft and update GitHub only when explicitly asked to update, edit, post, or publish.

Perform each requested outcome when combined. CLI access is never authorization to mutate a PR.

Workflow

  1. Identify the PR and base. Prefer gh pr view --json number,title,body,baseRefName,headRefName,url; without a PR, compare against the user-provided or repository default base. Fetch before relying on stale refs.
  2. Establish evidence from git status --short, diff stats and names, relevant commits, changed files, tests, docs, migrations, config, and generated artifacts. Treat .context/ as scratch and restate any useful fact because it is untracked. Do not rely on chat or memory for behavioral claims.
  3. Determine the problem, approach, outcome, deliberate exclusions, risk, compatibility, edge cases, operational gotchas, migrations, flags, cleanup, and reviewer focus. For close-review items, give a precise file/line reference and explanation. Every PR body must include one fenced excerpt of actual changed code, configuration, or documentation from the most review-critical hunk, capped at 15 lines; a link-only review section is insufficient.
  4. Inventory affected and added tests. Run the narrowest reliable checks, then documented broader validation when feasible. Classify coverage as sufficient, partially sufficient, or insufficient; name regressions it catches, important gaps, and concrete follow-up tests. Never claim confidence from unrun or irrelevant tests.
  5. Deliver only the authorized outcome:
    • Assessment: report evidence and coverage judgment without creating a body.
    • Draft: return the body or write .context/pr-description.md; never call gh pr edit.
    • Update/post: write .context/pr-description.md, then use gh pr edit <number> --body-file .context/pr-description.md. If posting fails, preserve the draft and explain why.

PR body

For draft/update work, load assets/pr-body.md.tmpl unless the repository has a stronger template. The body must stand alone without chat or local notes. Prefer high-signal context; add screenshots, rollout, migrations, flags, performance, accessibility, security, or release notes only when relevant. Remove an empty section only when it genuinely does not apply; use Not applicable when omitting it could hide an important review dimension.

Quality bar

  • Ground claims in code, tests, docs, commits, or command output; distinguish facts from assumptions and judgment.
  • Preserve the existing title and useful body content unless replacement is clearer.
  • Name behavior instead of saying “various fixes” or “improves behavior.”
  • Cite precise file/line references for close-review items. Include one actual changed excerpt in a fenced code block; it must be materially helpful and at most 15 lines.
  • Include failed, skipped, and unavailable validation with reasons.
  • Do not make unrelated code changes unless explicitly asked.

Final response

Report the PR URL when one exists, whether the outcome was an assessment, local draft, or posted update, validation commands/results, and the bottom-line coverage assessment. If an authorized post failed, report the draft path.

來源與署名

來源:biw/skills位於skills/detailed-pr-description提交5b8d923

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架