GitHubを見る前に
コード管理と秘密情報を分けて考える
GitHubはコード履歴や差分確認に向いています。APIキー、パスワード、DB情報などを置かないこともセットで確認しましょう。
まなぶちゃん
GitHubには何でも保存していいの？
GPTガイドくん
コード管理には便利ですが、秘密情報は入れません。差分を見るページと、入れてはいけないもののページを一緒に確認しましょう。
コードを見る差分を確認する秘密情報を避ける
Intermediate
GitHub中級編
GitHub中級では、変更をいきなり本体へ入れず、ブランチとPull Requestで確認する流れを覚えます。
このページは非公式の実践ガイドです。GitHubの画面や機能、料金、仕様は変わる可能性があります。最新情報が必要な場合は提供元情報を確認してください。
mainを直接触らない考え方
mainは本体に近い位置づけとして扱い、作業ブランチで変更を試してからPull Requestで確認する流れにします。これにより、差分を見やすくし、レビューや戻しの判断もしやすくなります。
Pull Requestは、変更を提案し、会話し、レビューしてから取り込むための仕組みです。長い引用は避けますが、提供元ドキュメントでも共同作業の基本機能として説明されています。
PRで見ること
差分、変更ファイル、説明文、チェック結果、レビューコメント、マージ前の確認項目を見ます。巨大な変更を1つのPRにまとめるとレビューしにくくなるため、目的ごとに小さく分けます。
IssueとPull Requestを紐づけると、なぜその変更をしたのかが追いやすくなります。レビューしやすいコミット単位にすることも大切です。
コンフリクトの基本
コンフリクトは、同じ場所を複数の変更が触った時に起きやすくなります。原因が分からないまま一気に直そうとせず、どの変更を残すか人間が確認します。
用語表
| 英語 | 日本語 | 意味 |
|---|---|---|
| main | メイン | 本体に近い基準ブランチ |
| feature branch | 作業ブランチ | 変更を試すための分岐 |
| diff | 差分 | 何が変わったかを表示するもの |
| review | レビュー | 変更を確認してコメントすること |
| conflict | コンフリクト | 変更同士がぶつかっている状態 |
悪い例 / 良い例
| 悪い例 | 良い例 |
|---|---|
| mainを直接編集する | 作業ブランチを作る |
| 変更内容を確認せずマージする | PRで差分を見る |
| 巨大な変更を1つのPRにまとめる | 小さめの変更に分ける |
| 説明なしでPRを出す | PR本文に目的を書く |
| レビューなしで進める | レビューしてからマージする |
PR説明文を整える例
このPull Requestの説明文を作ってください。変更目的、変更ファイル、確認したこと、未確認事項、リスク、戻す場合の注意を入れてください。やってはいけないこと
- 外へ出せない情報や接続情報を通常ファイルに書く
- mainへ大きな変更を直接反映する
- AIレビューだけで完了扱いにする
- リポジトリや作業環境を混ぜる
- 変更後の確認を人間が行わない
確認チェックリスト
- 作業ブランチを作った
- PR本文に目的を書いた
- 差分を見た
- 変更ファイルを確認した
- レビューコメントを確認した
- チェック結果を見た
- マージ前に人間が判断した