小文字の breaking change はフッターにならない
破壊的変更のつもりで小文字の「breaking change:」と書いた例です。規則 12 は大文字だけを認めるため、警告になります。
入力
コミットメッセージ
fix: handle null body text breaking change: removed flag
結果
エラー 0 件・警告 1 件・情報 0 件
指摘(エラー・警告・情報)
- 警告 メッセージ 1 の 5 行目 「breaking change」で始まる行がありますが、フッターとして読める位置(前の行が空行)にないか、大文字ではありません。BREAKING CHANGE は大文字で、本文との間に空行を置きます(規則 8・12)。
| 検査したメッセージ | 1 件 |
|---|---|
| 規則に適合 | 1 件 |
| 不適合 | 0 件 |
検査結果の表
| 番号 | 1 行目 | type | scope | 破壊的変更 | 判定 |
|---|---|---|---|---|---|
| 1 | fix: handle null | fix | - | なし | 適合(警告 1) |
検算(この結果になる理由)
規則 12 と 15 により、BREAKING CHANGE だけは大文字で書く必要があります。小文字ではフッターの token として読めず、破壊的変更として扱われないため、警告が 1 件出ます。
判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。
このツールの制約
- Git には標準のメッセージ規約がありません。この道具が検査するのは Conventional Commits 形式への適合だけで、他の規約(チーム独自の type の許可リストなど)は検査しません。
- 説明の言語・長さ・時制(命令形かどうか)など、Conventional Commits の規則にない書き方の好みは検査しません。
- リポジトリの履歴そのものは読みません。貼り付けたメッセージだけを検査します。
ご利用にあたって
- 検査に通っても、メッセージの内容が適切であることを意味しません。
- チーム独自の type の許可リストなど、追加のルールがある場合は別に確認してください。