Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.18 KB

commit-strategy.md

File metadata and controls

47 lines (33 loc) · 2.18 KB

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

コミットメッセージは以下の形式に従うべきです:

<型>[任意 スコープ]: <タイトル>

[任意 本文]

[任意 フッター]
  • : コミットの種類を表します。
  • スコープ: コミットが影響を与える範囲(オプション)。
  • タイトル: コミットの主な変更点を簡潔に説明します。
  • 本文: 変更内容の詳細な説明(オプション)。
  • フッター: 関連する Issue や Merge Request の参照など、追加情報(オプション)。

コミットの型

コミットメッセージで使用できる「型」は以下の通りです:

  • build: ビルドシステムや外部依存関係に影響を与える変更。
  • ci: CI(Continuous Integration)設定ファイルやスクリプトへの変更。
  • docs: ドキュメントのみの変更。
  • feat: 新しい機能の追加。
  • fix: バグの修正。
  • perf: パフォーマンスを向上させるコード変更。
  • refactor: バグ修正や新機能追加を行わずに、既存コードの改善・整理。
  • style: コードの意味に影響を与えない変更(空白、フォーマット、セミコロンの欠落など)。
  • test: テストの追加や既存テストの修正。

ベストプラクティス

  • タイトルは明確で簡潔に: タイトル行は 50 文字以内で変更の要約を述べるべきです。
  • 本文で詳細を説明: タイトルだけでは伝えきれない変更の動機やコンテキストを本文で説明してください。本文は 72 文字ごとに改行するのが一般的です。
  • フッターで参照を追加: 関連する Issue や Merge Request がある場合は、フッターにその参照を追加してください。

実践例

feat[ログイン機能]: 二要素認証を追加

ユーザーのセキュリティを向上させるため、ログインプロセスに二要素認証を追加しました。ユーザーは、パスワードに加えて、モバイルデバイスに送信されたコードを入力する必要があります。

Closes #123