開発Tips（2025-11-07）

Git

コミットメッセージの書き方を改善して、チームでの共同開発をスムーズにし、後々の変更履歴の追跡を容易にするテクニックです。 適切なコミットメッセージは、コードの変更意図を明確にし、プロジェクトの理解を深めます。

コミットメッセージを構造化する

• 説明: 標準的なコミットメッセージの構造を採用することで、可読性と検索性を向上させます。

• 構造:

  • タイトル: 短く（50文字以内）、変更内容を端的に説明する。
  • 本文: 必要に応じて、変更の背景、理由、詳細を記述する。（72文字以内で改行）
  • フッター: Issueトラッカーへの参照、関連PRへのリンクなどを記述する。

• 例:

  feat: ユーザー認証機能の実装
  
  ユーザーがログイン/ログアウトできるように、認証機能を実装しました。
  bcryptを使用してパスワードを安全にハッシュ化しています。
  
  Refs: #123 (Issue tracker reference)

• 注意点: タイトルは命令形（例：修正する、追加する）を使用する。本文はなぜ変更を行ったかを記述する。

• おすすめポイント: git config commit.template を使用して、毎回同じ構造のテンプレートを表示させることで、記述漏れを防ぎ、チーム全体で一貫性を保つことができます。