GitHubを見る前に
コード管理と秘密情報を分けて考える
GitHubはコード履歴や差分確認に向いています。APIキー、パスワード、DB情報などを置かないこともセットで確認しましょう。
まなぶちゃん
GitHubには何でも保存していいの？
GPTガイドくん
コード管理には便利ですが、秘密情報は入れません。差分を見るページと、入れてはいけないもののページを一緒に確認しましょう。
コードを見る差分を確認する秘密情報を避ける
Change history
GitHubで変更履歴を残す方法
GitHubをただの保存場所で終わらせず、いつ何を直したか分かる記録場所として使います。
このページは非公式の実践ガイドです。GitHubの画面や機能、仕様は変わる可能性があります。最新情報が必要な場合は、提供元が公開している情報も確認してください。コードやファイルの変更後は人間が確認してください。
このページで分かること
変更履歴の意味
コミットを作業のセーブポイントとして使う考え方が分かります。
良いコミット名
あとから見返しやすい変更名の付け方が分かります。
Codex後の確認
Codex作業後に変更ファイルと履歴を照らす流れが分かります。
GitHubは変更履歴を残せる場所
GitHubはコードを置くだけでなく、変更履歴を残す場所として使えます。コミットを見れば、いつ、何を、なぜ直したのかを追いやすくなります。
個人サイトでも変更履歴は役立ちます。ページ追加、内部リンク調整、CSS修正、sitemap更新などを小さく記録しておくと、後で原因を探しやすくなります。
コミットは作業のセーブポイント
コミットは作業の区切りです。大きな変更を1回にまとめるより、小さく分けた方が差分を確認しやすく、戻す時も判断しやすくなります。
悪いコミット名 / 良いコミット名
| 悪いコミット名 | 良いコミット名 |
|---|---|
| 修正 | トップページに初心者向け導線を追加 |
| いろいろ | 安全ページにNG例を追加 |
| 更新 | GitHub用語ページを追加 |
| test | スマホ表示の余白を調整 |
| 全部 | sitemapに新規ページを追加 |
悪い例 / 良い例
| 悪い例 | 良い例 |
|---|---|
| 大きな変更を1回のコミットにまとめる | 1つの目的ごとに小さくコミットする |
| コミット名を「更新」だけにする | 何を直したか分かる名前にする |
| Codex報告書を読まずに履歴だけ見る | 報告書とGitHub差分を合わせて見る |
| 戻す目印が分からない | 作業ごとに履歴を残す |
サイト制作での変更履歴例
- 1ページ追加した時にコミットする
- CSSの余白調整だけでコミットする
- 内部リンク追加だけでコミットする
- sitemap更新だけでコミットする
- 公開前チェック後の修正を分けて記録する
Codex作業後に変更ファイルを確認する
Codex作業後は、Codex報告書だけでなくGitHub側の差分も確認します。報告書にある変更ファイルと、実際の変更履歴が合っているかを見ると、想定外の変更に気づきやすくなります。
変更履歴チェックリスト
- コミット名で変更内容が分かる
- 1コミットが大きすぎない
- Codex報告書と変更ファイルが一致している
- sitemap変更の有無を確認した
- SEOタグの変更有無を確認した
- 戻す時の目印になる
- 人間が最終確認した
やってはいけないこと
- mainへ大きな変更を直接入れる
- 外へ出せない情報を通常ファイルへ置く
- AIレビューだけで完了扱いにする
- 複数サイトやリポジトリを同じ前提で混ぜる
- 差分や報告書を読まずに次へ進む