スコープ付きfixコミット
括弧内にスコープを持つfixコミットの書き方。スコープ付きConventional Commitsメッセージの正しい形式を学びます。
Valid Formats
詳細な説明
スコープ付きfixコミット
コミットメッセージにスコープを追加すると、コードベースのどの部分が影響を受けるかについて追加のコンテキストを提供します。スコープはタイプとコロン区切りの間に括弧で囲んで配置します。
形式
fix(parser): handle escaped quotes in strings
分解すると:
| 要素 | 値 | 目的 |
|---|---|---|
| タイプ | fix |
バグ修正を宣言 |
| スコープ | (parser) |
影響を受けるモジュールを特定 |
| 区切り | : |
必須のコロン + スペース |
| 説明 | handle escaped quotes in strings |
修正の内容 |
スコープの規約
スコープはコードベースのセクションを表す名詞にすべきです:
- モジュール名:
(auth)、(api)、(parser) - パッケージ名:
(core)、(cli)、(ui) - 機能領域:
(search)、(checkout)、(dashboard)
バージョンへの影響
fixコミットはセマンティックバージョニングでパッチバージョンバンプ(例:1.2.3から1.2.4)をトリガーします。スコープはバージョンバンプに影響しませんが、生成された変更ログでそれぞれのモジュール下にfixをグループ化することで改善します。
スコープに関するよくあるミス
- 閉じ括弧の欠落:
fix(parser: handle bug— リンターはこれを検出します。 - 空のスコープ:
fix(): handle bug— 技術的には有効ですが推奨されません。 - スコープ内のスペース:
fix(my parser): handle bug— スペースを避け、代わりにハイフンを使用してください。
ユースケース
モノレポや大規模プロジェクトで、変更が特定のモジュールに影響する場合にスコープ付きfixコミットを使用します。スコープはレビュアーがコードベースのどの部分が触れられたかをすばやく特定するのに役立ち、スコープ別にグループ化された変更ログをより整理されたものにします。