ツール
Conventional Commits クイックリファレンス
Conventional Commits クイックリファレンス の印刷用チートシート。すばやい参照、学習、机上利用向けに整理されています
サンプル
このチートシートの内容
- フォーマット
- タイプ
- スコープ
- 破壊的変更
- 例
- フッター
- ツール
- よくあるパターン
コミットメッセージの構造
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
各部の説明
type | 変更のカテゴリ(feat、fix など) |
scope | 影響を受けるコードベースのセクション(省略可) |
description | 命令形での短い要約 |
body | 詳細な説明(省略可、空行の後に記述) |
footer | BREAKING CHANGE やイシュー参照などのメタデータ |
ルール
命令形 | "add feature" であり "added feature" ではない |
type は小文字 | feat: であり Feat: ではない |
ピリオドなし | 説明は "." で終えない |
空行 | 本文/フッターと説明を空行で区切る |
すべてのセクションを含む印刷用チートシートをダウンロード
PDF をダウンロードダウンロード