GHgithubguide.jp

GitHubのcommit messageの書き方｜何を変えたか・なぜ変えたかを残す

commit messageは後から履歴を見る人への短いメモです。細かすぎる説明ではなく、変更の意図が追える言葉を残します。

このページでわかること

  • commit messageの役割がわかる
  • 何を変えたかとなぜ変えたかを短く残せる
  • AI/Codex作業でも検索しやすい履歴にできる

まず確認すること

  • 短く具体的に書く
  • 対象と目的が分かる言葉を入れる
  • 大量変更を1commitに詰めすぎない
  • 必要ならPR descriptionで詳しく補う

やってはいけないこと

  • 実在のSecretsや内部情報を書かない
  • 曖昧な感情文だけにしない
  • 万能テンプレートとして固定しすぎない

安全寄りに進める手順

  1. 対象のrepo、branch、PR、Actions runを確認する。
  2. Secrets、APIキー、token、.env、個人情報が差分やログに出ていないか見る。
  3. 必要な場合は値を停止または再発行し、影響範囲を整理する。
  4. 変更は小さなbranchとPRに分け、CIとreviewで確認する。

CodexやAI作業時の注意

AIに作業を渡す時は、対象ファイル、触らないファイル、確認項目を明記します。認証情報や実際のキー値は本文、Issue、PR説明、ログ、レポートに残さないようにします。

一次情報で確認する領域

Actions、Secrets、PR、repository visibility、workflow permissionsは仕様が変わることがあります。実作業前にはGitHub Docsで最新の説明を確認してください。

関連ページ