Conventional Commits を使用した Git Commit

概要

Conventional Commits 仕様を使用して、標準化されたセマンティックな git コミットを作成します。実際の diff を分析して、適切な type、scope、メッセージを決定します。

Conventional Commit フォーマット

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

コミットタイプ

Type	目的
feat	新機能
fix	バグ修正
docs	ドキュメント のみ
style	フォーマット/スタイル(ロジックなし)
refactor	コードリファクタ(機能/修正なし)
perf	パフォーマンス改善
test	テストの追加/更新
build	ビルドシステム/依存関係
ci	CI/設定変更
chore	メンテナンス/その他
revert	コミット取り消し

Breaking Changes

# type/scope の後に感嘆符
feat!: 廃止予定エンドポイントを削除

# BREAKING CHANGE フッター
feat: 他の設定を拡張できるように対応

BREAKING CHANGE: `extends` キーの動作が変更されました

ワークフロー

1. Diff を分析

# ファイルがステージされている場合は、ステージされた diff を使用
git diff --staged

# 何もステージされていない場合は、ワーキングツリーの diff を使用
git diff

# ステータスも確認
git status --porcelain

2. ファイルをステージ(必要に応じて)

何もステージされていない場合、または変更を異なる方法でグループ化したい場合:

# 特定のファイルをステージ
git add path/to/file1 path/to/file2

# パターンでステージ
git add *.test.*
git add src/components/*

# インタラクティブステージング
git add -p

シークレットはコミットしないでください (.env、credentials.json、秘密鍵)。

3. コミットメッセージを生成

diff を分析して以下を決定します:

• Type: このコミットはどのような変更か?
• Scope: どのエリア/モジュールに影響するか?
• Description: 何が変更されたかの 1 行サマリー(現在形、命令法、72 文字以下)

4. コミットを実行

# 単一行
git commit -m "<type>[scope]: <description>"

# body/footer を含む複数行
git commit -m "$(cat <<'EOF'
<type>[scope]: <description>

<optional body>

<optional footer>
EOF
)"

ベストプラクティス

• 1 コミットにつき 1 つの論理的な変更
• 現在形を使用: "added" ではなく "add"
• 命令法: "fixes bug" ではなく "fix bug"
• Issue を参照: Closes #123、Refs #456
• description は 72 文字以下に保つ

Git セーフティプロトコル

• git 設定を更新しない
• ユーザーの明示的な指示がない限り、破壊的なコマンド(--force、hard reset)を実行しない
• ユーザーが要求しない限り、フックをスキップしない(--no-verify)
• main/master への force push をしない
• フックが原因でコミットが失敗した場合は、修正して新しいコミットを作成する(amend しない)