GHgithubguide.jp

GitHub PR descriptionの書き方｜目的・変更内容・確認項目・リスクを残す

PR descriptionは差分を見る人への入口です。何を変えたかだけでなく、なぜ変えたか、何を確認したか、何が未確認かを残します。

このページでわかること

  • PR本文に入れる項目がわかる
  • reviewしてほしい点を明確にできる
  • AI/Codex作業の有無と確認結果を残せる

まず確認すること

  • 目的、背景、変更内容、対象ファイルを書く
  • 確認済みと未確認を分ける
  • 関連Issueやリスクを書く
  • Secretsや個人情報なし確認を書く

やってはいけないこと

  • PR本文に実値や顧客情報を書かない
  • 未確認を確認済みとしない
  • スクリーンショットやログを必要以上に貼らない

安全寄りに進める手順

  1. 対象のrepo、branch、PR、Actions runを確認する。
  2. Secrets、APIキー、token、.env、個人情報が差分やログに出ていないか見る。
  3. 必要な場合は値を停止または再発行し、影響範囲を整理する。
  4. 変更は小さなbranchとPRに分け、CIとreviewで確認する。

CodexやAI作業時の注意

AIに作業を渡す時は、対象ファイル、触らないファイル、確認項目を明記します。認証情報や実際のキー値は本文、Issue、PR説明、ログ、レポートに残さないようにします。

一次情報で確認する領域

Actions、Secrets、PR、repository visibility、workflow permissionsは仕様が変わることがあります。実作業前にはGitHub Docsで最新の説明を確認してください。

関連ページ