GitHubを見る前に
コード管理と秘密情報を分けて考える
GitHubはコード履歴や差分確認に向いています。APIキー、パスワード、DB情報などを置かないこともセットで確認しましょう。
まなぶちゃん
GitHubには何でも保存していいの？
GPTガイドくん
コード管理には便利ですが、秘密情報は入れません。差分を見るページと、入れてはいけないもののページを一緒に確認しましょう。
コードを見る差分を確認する秘密情報を避ける
GitHub + ChatGPT
GitHubとChatGPTの使い方
ChatGPTは、GitHub作業の前後にある説明文、Issue、PR本文、README、Codex指示文の整理に向いています。
このページは非公式の実践ガイドです。GitHubの画面や機能、料金、仕様は変わる可能性があります。最新情報が必要な場合は提供元情報を確認してください。
ChatGPTが向いているGitHub作業
ChatGPTは、Issue文を作る、Pull Request説明文を作る、READMEを下書きする、変更内容を初心者向けに要約する、レビュー観点を作る、リリースノートを作る、といった前後整理に向いています。
Codexへ渡す作業指示を作る時にも使えます。目的、対象ファイル、やること、やらないこと、確認方法、停止条件に分けると、Codex側の作業も安定しやすくなります。
貼りすぎない注意
未公開コードや外へ出せない情報を大量に貼るのは避けます。必要な範囲だけ要約し、公開してよい情報か、人間が確認してから使います。
GitHub用語を日本語で理解したい時は、英語の用語も残したまま説明してもらうと実務で使いやすくなります。
用語表
| 英語 | 日本語 | 意味 |
|---|---|---|
| Issue | 作業メモ | 目的や問題点を整理する場所 |
| Pull Request body | PR説明文 | 変更の目的や確認結果を書く欄 |
| README | 説明書 | リポジトリの概要や使い方を書くファイル |
| release note | リリースノート | 変更内容を利用者向けにまとめる文 |
| review points | レビュー観点 | 見るべきポイントの一覧 |
悪い例 / 良い例
| 悪い例 | 良い例 |
|---|---|
| 作業内容を一文だけでIssueにする | 目的、対象、確認方法に分ける |
| PR説明なしで出す | 変更目的と確認結果を書く |
| 外へ出せない情報をそのまま貼る | 必要な範囲だけ要約して相談する |
ChatGPT用プロンプト例
この作業内容を、GitHub Issueに貼れる形で整理してください。目的、対象ファイル、やること、やらないこと、確認方法、停止条件に分けてください。
このPull Requestの説明文を作ってください。変更目的、変更ファイル、確認したこと、未確認事項、リスク、戻す場合の注意を入れてください。やってはいけないこと
- 外へ出せない情報や接続情報を通常ファイルに書く
- mainへ大きな変更を直接反映する
- AIレビューだけで完了扱いにする
- リポジトリや作業環境を混ぜる
- 変更後の確認を人間が行わない
確認チェックリスト
- Issue文を目的別に整理した
- PR説明文に変更目的を書いた
- 確認したことを書いた
- 未確認事項を書いた
- READMEの対象読者を決めた
- 外へ出せない情報を貼っていない
- Codexへの指示文を分けた