GHgithubguide.jp

GitHub Issueで作業の背景を残す方法｜なぜ始めたか・何を決めたかを記録する

Issueは作業を始める理由や相談、決定事項を残す場所として使えます。PRだけでは見えにくい背景を補います。

このページでわかること

  • Issueに残すべき背景と目的がわかる
  • 関連PRや完了条件を整理できる
  • AI/Codexに渡す範囲を明確にできる

まず確認すること

  • なぜ必要か、現状、目的を書く
  • やることとやらないことを分ける
  • 対象URLや対象ファイルを必要最小限で書く
  • 関連PRと完了条件を残す

やってはいけないこと

  • IssueにSecretsや個人情報を書かない
  • 未確定事項を決定扱いしない
  • 社内情報を必要以上に公開しない

安全寄りに進める手順

  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で最新の説明を確認してください。

関連ページ