コミットメッセージジェネレーター

コミット詳細

0/72 文字

サマリーは必須です

何を、なぜ行ったかを説明し、方法は説明しない

ライブプレビュー

詳細を入力してコミットメッセージを生成...

関連ツール

偽データジェネレーターモックデータを生成Markdown プレビューワーライブ Markdown エディタとプレビューコード差分チェッカーコード/テキストを並べて比較

このツールについて

Conventional Commits仕様は、コミットメッセージの軽量な規約です。明示的なコミット履歴を作成するための簡単なルールセットを提供し、その上に自動化ツールを書くことを容易にします。

コミットメッセージの形式

<type>(<scope>): <subject>

<body>

<footer>

メリット

  • 自動的にCHANGELOGを生成
  • 自動的にセマンティックバージョンの更新を判断
  • チームメンバーや関係者に変更の性質を伝達
  • ビルドおよび公開プロセスをトリガー
  • より構造化されたコミット履歴を探索できるようにすることで、人々の貢献を容易に

一般的なタイプ

✨
feat — A new feature
🐛
fix — A bug fix
📚
docs — Documentation only changes
💎
style — Code style changes (formatting, etc)
♻️
refactor — Code refactoring
✅
test — Adding or updating tests

フッターの使用方法

フッターはオプションで、コミットに関するメタデータを含みます。一般的な使用例には以下があります：

破壊的変更: BREAKING CHANGE: を使用して、互換性のないAPI変更を示します。これにより、セマンティックバージョニングでメジャーバージョンの更新がトリガーされます。
BREAKING CHANGE: APIエンドポイントが認証を必要とするようになりました
ユーザーは認証トークンを含めるようにAPIクライアントを更新する必要があります
Issue参照: Closes、Fixes、Resolvesなどのキーワードを使用して、コミットをissueトラッカーにリンクします。
Closes #123
Fixes #456, #789
共著者とレビュアー: コミットに貢献者とレビュアーをクレジット。
Co-authored-by: John Doe <john@example.com>
Reviewed-by: Jane Smith <jane@example.com>