! とフッターで破壊的変更を示す
type の後ろの ! と、フッターの大文字 BREAKING CHANGE の両方を使い、本文とフッターを空行で区切った例です。
入力
コミットメッセージ
feat(api)!: drop v1 endpoints Remove the legacy endpoints. BREAKING CHANGE: v1 endpoints are removed Reviewed-by: Z
結果
エラー 0 件・警告 0 件・情報 1 件
指摘(エラー・警告・情報)
- 情報 メッセージ 1 の 1 行目 この規則の範囲では指摘はありません。
| 検査したメッセージ | 1 件 |
|---|---|
| 規則に適合 | 1 件 |
| 不適合 | 0 件 |
検査結果の表
| 番号 | 1 行目 | type | scope | 破壊的変更 | 判定 |
|---|---|---|---|---|---|
| 1 | feat(api)!: drop v1 endpoints | feat | api | あり | 適合 |
検算(この結果になる理由)
1 行目に ! があり、本文は 1 行空けて続き、最後の段落が BREAKING CHANGE: と Reviewed-by: の 2 つのフッターです。規則 6・8・12・13 を満たし、破壊的変更ありで適合です。
判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。
このツールの制約
- Git には標準のメッセージ規約がありません。この道具が検査するのは Conventional Commits 形式への適合だけで、他の規約(チーム独自の type の許可リストなど)は検査しません。
- 説明の言語・長さ・時制(命令形かどうか)など、Conventional Commits の規則にない書き方の好みは検査しません。
- リポジトリの履歴そのものは読みません。貼り付けたメッセージだけを検査します。
ご利用にあたって
- 検査に通っても、メッセージの内容が適切であることを意味しません。
- チーム独自の type の許可リストなど、追加のルールがある場合は別に確認してください。