Community寫作與編輯github.com

agentkitco/agentkit-dev-skills

根據實際的差異(diff)和提交記錄(commits)撰寫 Pull Request 的標題與描述,說明變更內容、原因、測試方式及審查重點。用於被要求撰寫或改進 PR 描述時。

agentkit-dev-skills 是什麼?

這個技能會自動從 Git 的提交記錄和差異(diff)中提取資訊,產生結構化的 Pull Request 描述,幫助審查者快速理解變更。它支援任何使用 Git 的專案,並遵循標準的 PR 模板結構,包含「為什麼」、「變更內容」、「如何審查」、「測試方式」及「部署風險」等區塊。技能會自動檢查是否有 `.github/pull_request_template.md` 模板,若有則優先填入。它的設計重點在於避免猜測動機、杜絕未經證實的聲明,並確保描述忠實反映 diff 的行為。對於未執行的測試,技能會誠實回報「未測試」。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/agentkitco/agentkit-dev-skills/tree/HEAD/skills/pr-description

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

寫一個審查者能用的 PR 描述

目標:讓審查者在兩分鐘內決定要看什麼,並讓未來的讀者理解這個變更存在的原因。

蒐集

  1. 找到基礎分支,然後執行 git log --oneline <base>..HEAD 和 git diff --stat <base>...HEAD,接著閱讀 diff。
  2. 尋找原因:提交記錄或分支名稱中關聯的 issue 或票證編號、使用者的請求、diff 中加入的註解。如果原因不在這些地方,請詢問使用者;不要自行編造動機。
  3. 檢查測試了什麼:diff 中的測試檔案,以及使用者執行的指令。如果測試沒有被執行,請直接說出來。
  4. 尋找是否有 .github/pull_request_template.md 或 PULL_REQUEST_TEMPLATE。如果有,則填入該模板,而不是使用下方的結構。

結構

<Title: 祈使句,不超過 70 個字元,命名行為變更,而不是檔案>

## Why
<問題或請求,用 1 到 3 句話說明。如果有的話,附上 issue 連結。>

## What changed
- <按領域分組的行為層級項目,而不是檔案列表。>

## How to review
- 從 <檔案或領域> 開始;其餘部分皆以此為基礎。
- 風險較高的部分:<最容易出錯的部分,以及原因>。
- 特意未變更的內容:<審查者可能預期看到但找不到的項目>。

## Testing
- <執行的確切指令與結果。>
- <手動步驟與觀察結果。如果有,請寫「未測試:...」>

## Rollout / risk
<遷移、設定、功能旗標、相容性、如何回退。只有在屬實時才寫「無」。>

規則

  • 描述 diff 實際做了什麼,而不是你希望它做了什麼。草擬後重新閱讀 diff,刪除任何它不支援的主張。
  • 不要列出每一個檔案。要列出行為變更、新設定、新相依套件以及被刪除的程式碼。
  • 不要有填充內容(如「此 PR 旨在...」)。除非該倉庫使用表情符號,否則不要使用表情符號。
  • 螢幕截圖或輸出範例:說明何處會有幫助;絕對不要描述你沒有看到的螢幕截圖。
  • 將標題和內容放在程式碼區塊中,以便複製。除非被要求,否則不要執行 gh pr create。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

相關技能