複数のメッセージ(大文字の type・docs・形式違反)
--- で区切った 3 つのメッセージで、大文字の type、feat・fix 以外の docs、コロンのない形式違反を一度に検査する例です。
入力
コミットメッセージ
Feat: Add search --- docs: update readme --- update stuff
結果
エラー 1 件・警告 0 件・情報 4 件
指摘(エラー・警告・情報)
- 情報 メッセージ 1 の 1 行目 type「Feat」は大文字小文字を区別せず feat として扱えます(規則 15)。ツールの都合がなければ小文字に揃えると読みやすくなります。
- 情報 メッセージ 1 の 1 行目 この規則の範囲では指摘はありません。
- 情報 メッセージ 2 の 1 行目 type「docs」は feat・fix 以外です。規則 14 で使うことは認められています(docs など)。
- 情報 メッセージ 2 の 1 行目 この規則の範囲では指摘はありません。
- エラー メッセージ 3 の 1 行目 1 行目が「type(scope): 説明」の形ではありません。type の後ろにコロンと空白が必要です(規則 1)。
| 検査したメッセージ | 3 件 |
|---|---|
| 規則に適合 | 2 件 |
| 不適合 | 1 件 |
検査結果の表
| 番号 | 1 行目 | type | scope | 破壊的変更 | 判定 |
|---|---|---|---|---|---|
| 1 | Feat: Add search | Feat | - | なし | 適合 |
| 2 | docs: update readme | docs | - | なし | 適合 |
| 3 | update stuff | - | - | なし | 不適合(エラー 1) |
検算(この結果になる理由)
Feat は規則 15 により大文字小文字を区別しないので適合、docs は規則 14 で使えるので適合です。3 つ目はコロンがなく規則 1 を満たさないため、エラー 1 件で不適合です。
判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。
このツールの制約
- Git には標準のメッセージ規約がありません。この道具が検査するのは Conventional Commits 形式への適合だけで、他の規約(チーム独自の type の許可リストなど)は検査しません。
- 説明の言語・長さ・時制(命令形かどうか)など、Conventional Commits の規則にない書き方の好みは検査しません。
- リポジトリの履歴そのものは読みません。貼り付けたメッセージだけを検査します。
ご利用にあたって
- 検査に通っても、メッセージの内容が適切であることを意味しません。
- チーム独自の type の許可リストなど、追加のルールがある場合は別に確認してください。