GitHub Issue template・PR templateの作り方
Issue templateやPR templateは、作業依頼や確認項目を揃えるために役立ちます。Codexや外注への作業指示でも、やることとやらないことを明確にできます。
このページでわかること
- 作業依頼の形式を揃える
- PRで確認すべき項目を残す
- Secretsや個人情報を書かない導線を作る
まず確認すること
- 目的、対象ファイル、やること、やらないことを書く
- CI、review担当、完了条件を入れる
- スクリーンショットや公開確認が必要か判断する
やってはいけないこと
- templateだけで確認完了と考える
- IssueやPRに機密情報を書く
- 社内情報を出しすぎる
安全寄りに進める手順
- 対象のrepo、branch、PR、Actions runを確認する。
- Secrets、APIキー、token、.env、個人情報が差分やログに出ていないか見る。
- 必要な場合は値を停止または再発行し、影響範囲を整理する。
- 変更は小さなbranchとPRに分け、CIとreviewで確認する。
CodexやAI作業時の注意
AIに作業を渡す時は、対象ファイル、触らないファイル、確認項目を明記します。認証情報や実際のキー値は本文、Issue、PR説明、ログ、レポートに残さないようにします。
一次情報で確認する領域
Actions、Secrets、PR、repository visibility、workflow permissionsは仕様が変わることがあります。実作業前にはGitHub Docsで最新の説明を確認してください。