<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/"><channel><title>Code Review on Eric 個人部落格</title><link>https://chihhung.github.io/Blog/tags/code-review/</link><description>Recent content in Code Review on Eric 個人部落格</description><generator>Hugo</generator><language>zh-TW</language><lastBuildDate>Tue, 06 Oct 2026 00:00:00 +0000</lastBuildDate><atom:link href="https://chihhung.github.io/Blog/tags/code-review/index.xml" rel="self" type="application/rss+xml"/><item><title>Pull Request 說明範本（Pull Request Template）</title><link>https://chihhung.github.io/Blog/posts/%E6%95%99%E5%AD%B8/templates/project/pullrequest_template/</link><pubDate>Tue, 06 Oct 2026 00:00:00 +0000</pubDate><guid>https://chihhung.github.io/Blog/posts/%E6%95%99%E5%AD%B8/templates/project/pullrequest_template/</guid><description>&lt;h1 id="pull-request-說明範本pull-request-template"&gt;Pull Request 說明範本（Pull Request Template）&lt;/h1&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;參照標準&lt;/strong&gt;：GitHub Pull Request Templates / Conventional Commits 1.0.0&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;文件用途&lt;/strong&gt;：統一 PR 說明格式，讓 Reviewer 知道改了什麼、為什麼改、如何驗證，以及 AI 參與了哪些部分&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;適用階段&lt;/strong&gt;：開發階段，每個 PR&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;範本版本&lt;/strong&gt;：v2.0（2026-10-06）｜對應《軟體開發標準程序教學手冊》v2.0 第 1.5、7.1 節&lt;/p&gt;&lt;/blockquote&gt;
&lt;hr&gt;
&lt;h2 id="-章節目錄"&gt;📋 章節目錄&lt;/h2&gt;
&lt;ol&gt;
&lt;li&gt;&lt;a href="#1-%E6%94%BE%E7%BD%AE%E4%BD%8D%E7%BD%AE"&gt;放置位置&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href="#2-pr-%E8%AA%AA%E6%98%8E%E5%85%A7%E5%AE%B9"&gt;PR 說明內容&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href="#3-%E8%87%AA%E5%8B%95%E6%AA%A2%E6%9F%A5-pr-%E8%AA%AA%E6%98%8E"&gt;自動檢查 PR 說明&lt;/a&gt;&lt;/li&gt;
&lt;li&gt;&lt;a href="#4-%E5%AF%A9%E6%9F%A5%E8%88%87%E9%A9%97%E8%AD%89"&gt;審查與驗證&lt;/a&gt;&lt;/li&gt;
&lt;/ol&gt;
&lt;hr&gt;
&lt;h2 id="1-放置位置"&gt;1. 放置位置&lt;/h2&gt;
&lt;h3 id="-範本"&gt;📝 範本&lt;/h3&gt;
&lt;table&gt;
&lt;thead&gt;
&lt;tr&gt;
&lt;th&gt;平台&lt;/th&gt;
&lt;th&gt;檔案位置&lt;/th&gt;
&lt;/tr&gt;
&lt;/thead&gt;
&lt;tbody&gt;
&lt;tr&gt;
&lt;td&gt;GitHub&lt;/td&gt;
&lt;td&gt;&lt;code&gt;.github/pull_request_template.md&lt;/code&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;GitLab&lt;/td&gt;
&lt;td&gt;&lt;code&gt;.gitlab/merge_request_templates/Default.md&lt;/code&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;tr&gt;
&lt;td&gt;Azure DevOps&lt;/td&gt;
&lt;td&gt;&lt;code&gt;.azuredevops/pull_request_template.md&lt;/code&gt;&lt;/td&gt;
&lt;/tr&gt;
&lt;/tbody&gt;
&lt;/table&gt;
&lt;h3 id="-使用說明"&gt;📖 使用說明&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;範本放在預設分支後，開 PR 時會自動帶入&lt;/li&gt;
&lt;li&gt;PR 標題採 Conventional Commits 格式（例：&lt;code&gt;feat(leave): 新增特休額度檢查&lt;/code&gt;），便於自動產生 CHANGELOG&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id="-範例"&gt;💡 範例&lt;/h3&gt;
&lt;div class="highlight"&gt;
&lt;pre tabindex="0"&gt;&lt;code class="language-text" data-lang="text"&gt;.github/
├── pull_request_template.md
├── CODEOWNERS
└── workflows/&lt;/code&gt;&lt;/pre&gt;
&lt;/div&gt;
&lt;hr&gt;
&lt;h2 id="2-pr-說明內容"&gt;2. PR 說明內容&lt;/h2&gt;
&lt;h3 id="-範本-1"&gt;📝 範本&lt;/h3&gt;
&lt;div class="highlight"&gt;
&lt;pre tabindex="0"&gt;&lt;code class="language-markdown" data-lang="markdown"&gt;## 變更摘要
{一到三句話說明改了什麼}（工作項目：{編號}）
## 變更原因
{為什麼需要這個變更；連結需求或事件}
## 變更類型
- [ ] 新功能（feat）　- [ ] 修正（fix）　- [ ] 重構（refactor）　- [ ] 不相容變更（BREAKING CHANGE）
## 驗證方式
- [ ] 自動化測試：{新增／修改的測試}
- [ ] 手動驗證：{步驟與結果}
## AI 參與範圍
- 使用工具：{工具名稱與版本，或「未使用」}
- AI 產生：{檔案／方法}
- 人工修改：{修改了 AI 產出的哪些部分與原因}
- 人工驗證方式：{如何確認 AI 產出正確}
## 審查重點
{請 Reviewer 特別注意的地方}
## 檢查清單
- [ ] 文件已更新（OpenAPI、SDD、ADR、README）
- [ ] 無機敏資訊（密碼、Token、真實個資）
- [ ] 資料庫變更可與舊版程式並存（Expand／Contract）&lt;/code&gt;&lt;/pre&gt;
&lt;/div&gt;
&lt;h3 id="-使用說明-1"&gt;📖 使用說明&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;「驗證方式」必須能證明功能正確，「看起來沒問題」不算&lt;/li&gt;
&lt;li&gt;「AI 參與範圍」讓 Reviewer 分配審查力道；作者必須能解釋 AI 產生的每一行&lt;/li&gt;
&lt;li&gt;不相容變更必須說明影響與遷移方式&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id="-範例-1"&gt;💡 範例&lt;/h3&gt;
&lt;div class="highlight"&gt;
&lt;pre tabindex="0"&gt;&lt;code class="language-markdown" data-lang="markdown"&gt;## 變更摘要
申請特休時檢查剩餘額度，不足時回傳 422 Problem Details（工作項目：HRMS-412）
## 變更原因
主管每月約退件 40 筆額度不足的申請（需求 FR-LV-002）
## 變更類型
- [x] 新功能（feat）
## 驗證方式
- [x] 自動化測試：`LeaveQuotaPolicyTest`（6 個案例，含剛好等於額度的邊界值）、`LeaveControllerIT`（422 回應格式）
- [x] 手動驗證：測試環境以 E20260001 申請 3 天（剩 2 天）→ 422，畫面顯示正確訊息
## AI 參與範圍
- 使用工具：GitHub Copilot（公司核准版本）
- AI 產生：`LeaveQuotaPolicy#check` 初版、`LeaveQuotaPolicyTest` 4 個案例
- 人工修改：補上半天假的額度計算（AI 版本只處理整天）；補上邊界值測試
- 人工驗證方式：本機 `mvn verify` 通過；PIT mutation score 85%
## 審查重點
- 半天假（0.5 天）的比較是否有浮點誤差（已改用 BigDecimal）
## 檢查清單
- [x] 文件已更新（OpenAPI：新增 422 回應）
- [x] 無機敏資訊
- [x] 無資料庫變更&lt;/code&gt;&lt;/pre&gt;
&lt;/div&gt;
&lt;hr&gt;
&lt;h2 id="3-自動檢查-pr-說明"&gt;3. 自動檢查 PR 說明&lt;/h2&gt;
&lt;h3 id="-範本-2"&gt;📝 範本&lt;/h3&gt;
&lt;div class="highlight"&gt;
&lt;pre tabindex="0"&gt;&lt;code class="language-yaml" data-lang="yaml"&gt;# .github/workflows/pr-description.yml：檢查 PR 說明的必要段落
name: PR description check
on:
pull_request:
types: [opened, edited, synchronize]
permissions:
contents: read
jobs:
check:
runs-on: ubuntu-latest
steps:
- name: Require sections
env:
BODY: ${{ github.event.pull_request.body }}
run: |
for section in &amp;#34;## 變更摘要&amp;#34; &amp;#34;## 驗證方式&amp;#34; &amp;#34;## AI 參與範圍&amp;#34;; do
if ! printf &amp;#39;%s&amp;#39; &amp;#34;$BODY&amp;#34; | grep -qF &amp;#34;$section&amp;#34;; then
echo &amp;#34;::error::PR 說明缺少段落：$section&amp;#34;
exit 1
fi
done&lt;/code&gt;&lt;/pre&gt;
&lt;/div&gt;
&lt;h3 id="-使用說明-2"&gt;📖 使用說明&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;PR 說明屬使用者可控內容，必須透過 &lt;code&gt;env&lt;/code&gt; 傳入，&lt;strong&gt;不可&lt;/strong&gt;在 &lt;code&gt;run:&lt;/code&gt; 中直接寫 &lt;code&gt;${{ github.event.pull_request.body }}&lt;/code&gt;，否則可能造成指令注入&lt;/li&gt;
&lt;li&gt;此 Job 設為分支保護的必要檢查&lt;/li&gt;
&lt;/ul&gt;
&lt;h3 id="-範例-2"&gt;💡 範例&lt;/h3&gt;
&lt;p&gt;PR 說明缺少「AI 參與範圍」時，Job 輸出：&lt;/p&gt;</description></item></channel></rss>