基本的なfeatコミットメッセージ
Conventional Commits仕様に従った基本的なfeatコミットメッセージの書き方。タイプ、コロン+スペース区切り、説明について解説します。
Valid Formats
詳細な説明
基礎:featコミット
featタイプはConventional Commitsで最も重要な2つのタイプの1つです(もう1つはfix)。コードベースのユーザーに見える新機能を導入するコミットであることを示します。standard-versionやsemantic-releaseなどのツールは、featコミットを使用してセマンティックバージョニングでマイナーバージョンバンプ(例:1.2.0から1.3.0)をトリガーします。
基本的なfeatコミットの構造
feat: add user registration form
この1行には3つの要素が含まれています:
| 要素 | 値 | 目的 |
|---|---|---|
| タイプ | feat |
新機能の導入を宣言 |
| 区切り | : |
コロンの後にスペース(必須) |
| 説明 | add user registration form |
変更の要約(命令形) |
良い説明の書き方
説明は命令形("add"であり"added"や"adds"ではない)を使い、小文字で始め、末尾にピリオドを付けません。「このコミットを適用すると、add user registration form」という文を完成させるように考えてください。
すべてのルールをパスする理由
- 有効なタイプ:
featはデフォルトの許可タイプリストに含まれています。 - コロン + スペース:
:区切りが存在します。 - 空でない説明:説明が変更を明確に述べています。
- 件名の長さ:35文字で、72文字の制限を大幅に下回っています。
- スコープなし:スコープはオプションなので、省略しても有効です。
ユースケース
特定のモジュールに属さない新機能を追加する場合や、プロジェクトがスコープ付きコミットを使用していない場合に基本的なfeatコミットを使用します。Conventional Commitsに従うプロジェクトで最も一般的なコミット形式です。