開発Tips（2025-12-06）

Git

Gitのコミットメッセージを改善して、プロジェクトの可読性と保守性を高めましょう。明確なコミットメッセージは、変更履歴を理解しやすくし、チーム間のコミュニケーションを円滑にします。

コミットメッセージのテンプレートを活用する

コミットメッセージのテンプレートを設定することで、一貫性のある形式でメッセージを記述できます。テンプレートは、変更の種類、影響範囲、理由などの情報を構造的に記述するのに役立ちます。

説明：

1. プロジェクトのルートディレクトリに .gitmessage.txt というファイルを作成します。
2. テンプレートの内容を記述します。例えば:

feat: 新機能の追加
docs: ドキュメントの更新
fix: バグ修正
refactor: リファクタリング
test: テストの追加/修正
chore: ビルドプロセス/補助ツール/ライブラリなどの変更

詳細な説明:

[変更の理由]

[変更の詳細]

[関連するチケット/issue番号]

3. Gitの設定で、このファイルをコミットメッセージのテンプレートとして設定します。

git config --local commit.template .gitmessage.txt

コミット時に git commit を実行すると、このテンプレートがエディタに表示され、記述を促します。

git commit

注意点：

• プロジェクトごとにローカル設定 (--local) を行うことを推奨します。
• テンプレートはあくまでガイドラインです。必要に応じて内容を修正してください。

おすすめポイント：

• コミットメッセージが標準化され、レビューが容易になります。
• 新規メンバーがプロジェクトに貢献しやすくなります。
• 変更履歴から、変更の背景や意図を把握しやすくなります。