GitHub practical guide for AI website work

GitHubとChatGPTを連携して使う方法

ChatGPTをGitHub作業の前後整理に使い、Issue、PR本文、Codex指示文、チェックリストを作る流れをまとめます。

当サイトはGitHubやOpenAIの運営サイトではありません。GitHub、Codex、ChatGPTを実務で使うための非公式ガイドです。

画面、機能、連携条件、料金や利用条件は変わる可能性があります。最新情報が必要な場合は、各提供元が公開している情報を確認してください。

まなぶちゃんがCodex作業の読み方を確認しているイラスト GPTガイドくんがCodex作業の確認ポイントを説明しているイラスト

GitHubを見る前に

コード管理と秘密情報を分けて考える

GitHubはコード履歴や差分確認に向いています。APIキー、パスワード、DB情報などを置かないこともセットで確認しましょう。

まなぶちゃん

GitHubには何でも保存していいの?

GPTガイドくん

コード管理には便利ですが、秘密情報は入れません。差分を見るページと、入れてはいけないもののページを一緒に確認しましょう。

コードを見る差分を確認する秘密情報を避ける

このページで分かること

ChatGPTは、GitHubの実ファイルを直接安全に操作する役というより、作業前の要件整理、Issue文、PR本文、差分説明、README下書き、レビュー観点の整理に向いています。Codexに渡す前の依頼文を作る時にも便利です。

ChatGPTが向いているGitHub作業

  • 作業前の要件整理
  • Issue文の作成
  • Codexへの指示文作成
  • PR本文の下書き
  • 差分説明の要約
  • READMEの下書き
  • チェックリスト作成
  • レビュー観点の整理
  • リリースノートの下書き

秘密情報を貼りすぎない

ChatGPTに相談する時は、未公開コード、認証情報、顧客名、案件名、社内事情をそのまま貼りすぎないようにします。公開情報や一般化した内容で相談し、具体的な差分確認はGitHubとCodex側で行うなど、役割を分けます。

Issue文を作るプロンプト

この作業内容を、GitHub Issueに貼れる形で整理してください。目的、対象ファイル、やること、やらないこと、確認方法、停止条件に分けてください。秘密情報や実案件名は一般化してください。

PR説明文を作るプロンプト

このPull Requestの説明文を作ってください。変更目的、変更ファイル、確認したこと、未確認事項、リスク、戻す場合の注意を入れてください。読み手が差分を見る前に概要を理解できる形にしてください。

Codex指示文を作るプロンプト

Codexに渡す指示文を作ってください。main直変更は禁止、作業ブランチで対応、触ってよいファイルと触ってはいけないファイル、確認項目、停止条件、報告書形式を入れてください。

人間が確認すること

  • ChatGPTの要約が差分と一致している
  • 秘密情報が含まれていない
  • PR本文が誤解を招かない
  • Codex指示文に禁止事項がある
  • 確認チェックリストが実行可能
  • 重要判断をAIに丸投げしていない

関連ページ

このカテゴリの親ページへ戻る

同じカテゴリのページを続けて読む場合は、親ページの一覧から選ぶと迷いにくくなります。

GitHubの使い方シリーズも読む

この内容に関連して、GitHubの入門からCodex・ChatGPT連携までを段階別に整理しています。