GitHub + Codex
GitHubとCodexの使い方
GitHubとCodexを組み合わせる時は、接続範囲を絞り、PR差分と報告書を人間が確認します。
このページは非公式の実践ガイドです。GitHubの画面や機能、料金、仕様は変わる可能性があります。最新情報が必要な場合は提供元情報を確認してください。
GitHubとCodexを組み合わせる意味
Codexは、GitHub上の差分確認、Pull Requestレビュー、変更ファイルの整理、不要ファイルの混入確認、SEOタグの意図しない変更確認に使えます。
ただし、リポジトリ接続前には対象を絞ります。必要最小限のリポジトリだけ接続し、作業ブランチを使い、mainへの直接反映を避ける運用が安全です。
CodexにPRレビューを頼む
Codexレビューでは、重大な不具合、セキュリティ上の問題、SEOタグの意図しない変更、重要情報の混入、不要ファイルの混入、戻しにくい変更を優先して見ます。
軽微な好みの指摘より、実害がありそうな点を優先します。Codexのレビュー結果は、人間レビューの補助として扱います。
用語表
| 英語 | 日本語 | 意味 |
|---|---|---|
| repository access | 接続範囲 | Codexが見る対象の範囲 |
| pull request review | PRレビュー | 変更を取り込む前の確認 |
| diff | 差分 | 変更前後の違い |
| work branch | 作業ブランチ | 本体とは別に作業する分岐 |
| report | 報告書 | Codexの確認結果 |
悪い例 / 良い例
| 悪い例 | 良い例 |
|---|---|
| 全リポジトリを接続する | 必要最小限のリポジトリだけ接続する |
| mainへ直接大きく反映する | 作業ブランチとPRで確認する |
| Codexレビューだけで完了扱いにする | Codexレビューを人間レビューの補助にする |
Codexレビュー依頼文例
このPull Requestをレビューしてください。重大な不具合、セキュリティ上の問題、SEOタグの意図しない変更、重要情報の混入、不要ファイルの混入、戻しにくい変更がないか確認してください。軽微な好みの指摘ではなく、実害がありそうな点を優先してください。やってはいけないこと
- 外へ出せない情報や接続情報を通常ファイルに書く
- mainへ大きな変更を直接反映する
- AIレビューだけで完了扱いにする
- リポジトリや作業環境を混ぜる
- 変更後の確認を人間が行わない
確認チェックリスト
- 必要最小限のリポジトリだけ接続した
- 作業ブランチを使った
- PR差分を確認した
- Codexにレビュー観点を指定した
- 重要情報の混入を確認した
- 不要ファイルを確認した
- 人間レビューを行った
つないだ後に最初に確かめること
接続そのものより、つないだ後の「どこを対象にしているか」で詰まることが多いところです。次の順に確かめてください。
- どの置き場所を見ているか言わせる。複数あると、想定と別の場所を直していることがあります。「直したはずなのに変わらない」の原因の大半がこれです
- 読めるだけか、書き込めるか。読み取りだけの権限では反映できません。エラーの文面が権限の話だと分かりにくいことがあります
- 組織の設定で止まっていないか。個人では使えても、組織の下では管理者の許可が要ります
確かめ方は公開されているものを開いて、変更後の文字が入っているかを見ることです。手元のファイルを見ても、反映されたかどうかは分かりません。
認証情報を記録に残さない
連携には接続情報が要りますが、作業用のファイルに直接書くと記録に残ります。後から消しても履歴からは消えません。
- 置き場所を作業用ファイルの外に決める。1か所にまとめ、そこから読ませます
- 実行するときにだけ渡す。その場限りなら、ファイルにも記録にも残りません
- 画面に出さない。確認のつもりで表示すると、作業のログに残ります
- 使い捨ての処理にも同じ規則を適用する
4つ目が実際にいちばん起きます。本番用の道具より、その場で書いた検証用の処理のほうが危険です。規則を適用する対象から外れやすいためです。まとめて記録に加える前に、入っているファイルの一覧を必ず見てください。