新機能・修正・docs・マージが混ざる一覧
feat(scope つき)・fix・docs・マージコミットの 4 件を、新機能・バグ修正・その他の変更・その他に分ける標準的な例です。
入力
git log --oneline の出力
a1b2c3d feat(ui): add dark mode b2c3d4e fix: crash on empty input c3d4e5f docs: update readme d4e5f6a Merge branch 'dev'
その他のコミット
「その他」として下書きに含める
結果
エラー 0 件・警告 0 件・情報 1 件
指摘(エラー・警告・情報)
- 情報 分類 Conventional Commits の形式(type: 説明)ではない行が 1 行あり、「その他」に入れました。
| 読んだコミット | 4 件 |
|---|---|
| 新機能(feat) | 1 件 |
| バグ修正(fix) | 1 件 |
| 破壊的変更(!) | 0 件 |
| その他 | 2 件 |
リリースノートの下書き(Markdown)
## 新機能 - **ui:** add dark mode (a1b2c3d) ## バグ修正 - crash on empty input (b2c3d4e) ## その他の変更(feat・fix 以外の type) - update readme (c3d4e5f) [docs] ## その他(Conventional Commits の形式ではないコミット) - Merge branch 'dev' (d4e5f6a)
検算(この結果になる理由)
feat は新機能、fix はバグ修正に入ります。docs は feat・fix 以外の type として「その他の変更」、Conventional Commits の形でないマージコミットは「その他」に入ります。scope は太字で添えます。
判定の根拠は仕様と根拠に、仕様の出典とともにまとめています。自分の入力で試すにはツールをお使いください。
このツールの制約
- 読めるのはコミットの 1 行目だけです。本文のフッターにある BREAKING CHANGE は、--oneline の出力に含まれないため検出できず、type の後ろの ! がある場合だけ破壊的変更になります。
- マージコミットや、チーム独自の書き方のコミットは「その他」に入ります。内容の要約や言い換えはせず、1 行目をそのまま使います。
- 下書きは参考です。読み手に伝わる文面にするには、人が表現を整える必要があります。
ご利用にあたって
- 生成された下書きをそのまま公開せず、内容を読んで確認してください。
- コミットメッセージに含まれる機密情報や個人名を、公開前に確認してください。