章7: AI生成PRのレビュー観点を追記#189
Conversation
There was a problem hiding this comment.
Pull request overview
第7章(Pull Request/レビュー運用)に、AI生成/エージェント生成PRを「安全に」マージするための最小レビュー観点を追加し、あわせてPRテンプレートにも同観点のチェック欄を追記するPRです。
Changes:
- 第7章に「AI生成PRのレビュー観点(最小セット)」の節を追加
.github/PULL_REQUEST_TEMPLATE.mdに AI/エージェント支援時の追加チェックリストを追加
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| manuscript/chapter-pull-requests/index.md | AI生成PRのレビュー観点(意図/検証/差分/依存/Secrets/ロールバック)を本文に追記 |
| .github/PULL_REQUEST_TEMPLATE.md | AI/エージェント支援時のレビュー観点チェック欄をテンプレに追加 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **差分の過剰さ**:関係ないリファクタやフォーマット変更が混ざっていないか | ||
| - **依存関係/設定変更**:更新理由と影響(リスク)が説明されているか | ||
| - **Secrets/個人情報**:トークン・秘密鍵・顧客情報・ログの貼付がないか | ||
| - **revert可能性**:PRが小さく、ロールバック手順が明記されているか |
There was a problem hiding this comment.
revert可能性 が本文内の用語(直前の「ロールバック」や PR テンプレの「ロールバック」)と表記・概念が混在しており、初心者には「revert とロールバックのどちらを指すのか」が曖昧になります。この観点は「ロールバック可能性」など既存の用語に寄せ、必要なら括弧で git revert を補足する形に統一すると誤解が減ります。
| - **revert可能性**:PRが小さく、ロールバック手順が明記されているか | |
| - **ロールバック可能性(例:`git revert`で戻しやすいか)**:PRが小さく、ロールバック手順が明記されているか |
There was a problem hiding this comment.
ご指摘のとおり用語が混在していたため、本文の表記を「ロールバック可能性」に統一し、括弧で git revert を補足しました(989f962)。
| ## レビュー観点(AI/エージェント支援時・該当する場合) | ||
|
|
||
| - [ ] 変更意図がIssueの受入基準に一致している | ||
| - [ ] テスト/動作確認の証跡がある(ログ・スクショ・手順) |
There was a problem hiding this comment.
ここだけ「スクショ」になっており、他の文書で多用されている「スクリーンショット」表記(例: README.md:106, UPDATE_POLICY.md:19 など)と表記ゆれになります。PRテンプレ側も「スクリーンショット」に揃えると一貫します。
| - [ ] テスト/動作確認の証跡がある(ログ・スクショ・手順) | |
| - [ ] テスト/動作確認の証跡がある(ログ・スクリーンショット・手順) |
There was a problem hiding this comment.
表記ゆれを避けるため、PRテンプレート内の「スクショ」を「スクリーンショット」に統一しました(989f962)。
|
Copilot のインライン指摘2件を反映しました(989f962)。
コンフリクトなし、CIは全てPASSです。 |
Closes #184
Refs #182 #187
変更概要
.github/PULL_REQUEST_TEMPLATE.mdに、AI/エージェント支援時の追加チェック欄を追記確認